From aefeb9ff5ec5c7ce3c20f420db1116c31f034615 Mon Sep 17 00:00:00 2001 From: Venkata Harish K Kajur Date: Tue, 30 Jan 2018 14:04:13 -0500 Subject: [PATCH] Update the files for ajsc 6 changes Issue-ID: AAI-33 Change-Id: I897566e79eb7505232b692e551f6347e69fafed6 Signed-off-by: Venkata Harish K Kajur --- aai-client-loadbalancer/pom.xml | 90 + .../java/org/onap/aai/AAIRibbonConfiguration.java | 54 + .../main/java/org/onap/aai/config/HttpPing.java | 68 + .../java/org/onap/aai/config/HttpPingImpl.java | 251 + aai-core/pom.xml | 280 +- .../main/java/org/onap/aai/config/DmaapConfig.java | 110 + .../org/onap/aai/config/SpringContextAware.java | 42 + .../onap/aai/dmaap/AAIDmaapEventJMSProducer.java | 14 +- .../main/java/org/onap/aai/dmaap/JMSConsumer.java | 160 + .../main/java/org/onap/aai/dmaap/JMSProducer.java | 58 + .../java/org/onap/aai/dmaap/MessageProducer.java | 29 + .../org/onap/aai/introspection/ModelInjestor.java | 31 +- .../org/onap/aai/introspection/MoxyLoader.java | 18 +- .../org/onap/aai/util/AAIApiServerURLBase.java | 35 +- .../main/java/org/onap/aai/util/AAICSVWriter.java | 168 - .../src/main/java/org/onap/aai/util/AAIConfig.java | 9 - .../org/onap/aai/util/StoreNotificationEvent.java | 47 +- .../aai/introspection/sideeffect/DataCopyTest.java | 2 +- .../java/org/onap/aai/util/AAICSVWriterTest.java | 77 - .../onap/aai/util/StoreNotificationEventTest.java | 2 +- .../etc => }/oxm/aai_oxm_v10.xml | 0 .../etc => }/oxm/aai_oxm_v11.xml | 0 .../etc => }/oxm/aai_oxm_v12.xml | 14 +- .../etc => }/oxm/aai_oxm_v8.xml | 0 .../etc => }/oxm/aai_oxm_v9.xml | 0 .../etc => }/oxm/sideeffect/nested-case.json | 0 .../aai_swagger_html/aai_swagger_v10.html | 90842 +++++++++++------- .../aai_swagger_html/aai_swagger_v11.html | 70404 +++++++++----- .../resources/aai_swagger_html/aai_swagger_v8.html | 51383 +++++++--- .../resources/aai_swagger_html/aai_swagger_v9.html | 93294 ++++++++++++------- .../aai_swagger_yaml/aai_swagger_v10.yaml | 29379 +++++- .../aai_swagger_yaml/aai_swagger_v11.yaml | 35162 +++++-- .../resources/aai_swagger_yaml/aai_swagger_v8.yaml | 29688 +++++- .../resources/aai_swagger_yaml/aai_swagger_v9.yaml | 30863 ++++-- pom.xml | 1 + 35 files changed, 300311 insertions(+), 132264 deletions(-) create mode 100644 aai-client-loadbalancer/pom.xml create mode 100644 aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java create mode 100644 aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java create mode 100644 aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java create mode 100644 aai-core/src/main/java/org/onap/aai/config/DmaapConfig.java create mode 100644 aai-core/src/main/java/org/onap/aai/config/SpringContextAware.java create mode 100644 aai-core/src/main/java/org/onap/aai/dmaap/JMSConsumer.java create mode 100644 aai-core/src/main/java/org/onap/aai/dmaap/JMSProducer.java create mode 100644 aai-core/src/main/java/org/onap/aai/dmaap/MessageProducer.java delete mode 100644 aai-core/src/main/java/org/onap/aai/util/AAICSVWriter.java delete mode 100644 aai-core/src/test/java/org/onap/aai/util/AAICSVWriterTest.java rename aai-core/src/test/resources/{bundleconfig-local/etc => }/oxm/aai_oxm_v10.xml (100%) rename aai-core/src/test/resources/{bundleconfig-local/etc => }/oxm/aai_oxm_v11.xml (100%) rename aai-core/src/test/resources/{bundleconfig-local/etc => }/oxm/aai_oxm_v12.xml (99%) rename aai-core/src/test/resources/{bundleconfig-local/etc => }/oxm/aai_oxm_v8.xml (100%) rename aai-core/src/test/resources/{bundleconfig-local/etc => }/oxm/aai_oxm_v9.xml (100%) rename aai-core/src/test/resources/{bundleconfig-local/etc => }/oxm/sideeffect/nested-case.json (100%) diff --git a/aai-client-loadbalancer/pom.xml b/aai-client-loadbalancer/pom.xml new file mode 100644 index 00000000..3a100371 --- /dev/null +++ b/aai-client-loadbalancer/pom.xml @@ -0,0 +1,90 @@ + + 4.0.0 + + org.onap.aai.aai-common + aai-common + 1.2.1-SNAPSHOT + + aai-client-loadbalancer + 1.2.1-SNAPSHOT + + + + org.apache.maven.plugins + maven-compiler-plugin + + ${java.version} + ${java.version} + + + + + jar + + aai-client-loadbalancer + AAI Client Side Loader Balancer to replace Dmaap + + + UTF-8 + 1.8 + + + + + org.springframework.cloud + spring-cloud-starter-ribbon + + + org.springframework.cloud + spring-cloud-commons + + + org.springframework.boot + spring-boot-starter-web + 1.5.2.RELEASE + + + com.att.eelf + eelf-core + 1.0.0 + + + org.springframework.retry + spring-retry + 1.2.1.RELEASE + + + + + + + org.springframework.cloud + spring-cloud-dependencies + Camden.SR5 + pom + import + + + + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + true + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + + diff --git a/aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java b/aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java new file mode 100644 index 00000000..4c639e44 --- /dev/null +++ b/aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java @@ -0,0 +1,54 @@ +/** + * ============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; + +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.ILoadBalancer; +import com.netflix.loadbalancer.LoadBalancerBuilder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cloud.client.loadbalancer.LoadBalanced; +import org.springframework.context.annotation.Bean; +import org.springframework.web.client.RestTemplate; + +/** + * AAIRibbonConfiguration is responsible for configuring the dmaap + * and it reads the users the application properties class + * and is mostly configurable via properties + */ +public class AAIRibbonConfiguration { + + @Autowired + IClientConfig ribbonClientConfig; + + @Bean + public ILoadBalancer ribbonLoadBalancer() { + return LoadBalancerBuilder.newBuilder() + .withClientConfig(ribbonClientConfig) + .buildLoadBalancerFromConfigWithReflection(); + } + + @LoadBalanced + @Bean + public RestTemplate loadBalancedRestTemplate(){ + return new RestTemplate(); + } +} diff --git a/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java new file mode 100644 index 00000000..4ecbfb60 --- /dev/null +++ b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java @@ -0,0 +1,68 @@ +/** + * ============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.config; + +import java.util.Optional; + +/** + * HttpPing interface provides access to update the endpoint and + * and the security level of the server that the user is trying to access + */ +public interface HttpPing { + + /** + * Sets the endpoint that the http get request will + * make to verify if the url can be reached + * + * @param endpoint - the endpoint of the url that is used to do healthcheck + */ + void setHealthCheckEndpoint(String endpoint); + + /** + * Returns the health check endpoint that the implementation + * will use in order to verify if the server is reachable at that location + * + * @return endpoint - the endpoint of the url that is used to do healthcheck + */ + String getHealthCheckEndpoint(); + + /** + * Set the credentials for the rest endpoint to verify authorization + * + * @param username - the username to the server trying to connect to + * @param password - the password to the server trying to connect to + */ + void setCredentials(String username, String password); + + /** + * Return the base64 authorization string set from the username and password + * + * @return encoded string using base64 of the username and password values + * like this: + * 
+     * @{code
+     *      "username:password" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
+     * }
+     *
+ */ + Optional getAuthorization(); +} diff --git a/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java new file mode 100644 index 00000000..2e5804eb --- /dev/null +++ b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java @@ -0,0 +1,251 @@ +/** + * ============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.config; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import com.netflix.client.config.DefaultClientConfigImpl; +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.IPing; +import com.netflix.loadbalancer.Server; +import org.springframework.http.*; +import org.springframework.web.client.HttpClientErrorException; +import org.springframework.web.client.RestTemplate; + +import java.io.IOException; +import java.net.InetSocketAddress; +import java.net.Socket; +import java.net.SocketAddress; +import java.util.Base64; +import java.util.Collections; +import java.util.Map; +import java.util.Optional; + +public class HttpPingImpl implements HttpPing, IPing { + + private static final EELFLogger logger = EELFManager.getInstance().getLogger(HttpPingImpl.class); + + private static final Base64.Encoder base64Encoder = Base64.getEncoder(); + + private static final HttpHeaders HTTP_HEADERS = new HttpHeaders(); + + // This is a workaround for the topics that the user + // does not have the access to read their own topic status + private static final String MR_STATUS_PATTERN = ".*\"mrstatus\":\\s*4002.*"; + + private static final int HTTPS_PORT = 3905; + private static final int DEFAULT_TIMEOUT = 2; + + private String healthCheckEndpoint; + private String username; + private String password; + + private int timeout; + + private final RestTemplate restTemplate; + + public HttpPingImpl(String healthCheckEndpoint) { + this(new RestTemplate()); + this.healthCheckEndpoint = healthCheckEndpoint; + this.timeout = DEFAULT_TIMEOUT; + } + + public HttpPingImpl(RestTemplate restTemplate) { + this.restTemplate = restTemplate; + this.healthCheckEndpoint = ""; + this.timeout = DEFAULT_TIMEOUT; + } + + public HttpPingImpl() { + this(""); + } + + public HttpPingImpl(IClientConfig clientConfig) { + + if (!(clientConfig instanceof DefaultClientConfigImpl)) { + throw new UnsupportedOperationException("Unable to support the client config implementation: " + clientConfig.getClass().getName()); + } + + DefaultClientConfigImpl defaultClientConfig = (DefaultClientConfigImpl) clientConfig; + + Map map = defaultClientConfig.getProperties(); + + this.setCredentials(map.get("username").toString(), map.get("password").toString()); + this.setHealthCheckEndpoint(map.get("health.endpoint").toString()); + this.setTimeoutInSecs(Integer.valueOf(map.get("pingport.timeout").toString())); + + this.restTemplate = new RestTemplate(); + } + + /** + * {@inheritDoc} + */ + @Override + public void setHealthCheckEndpoint(String endpoint) { + this.healthCheckEndpoint = endpoint; + } + + /** + * {@inheritDoc} + */ + @Override + public String getHealthCheckEndpoint() { + return healthCheckEndpoint; + } + + @Override + public void setCredentials(String username, String password) { + this.username = username; + this.password = password; + } + + public void setTimeoutInSecs(int timeout) { + this.timeout = timeout; + } + + @Override + public Optional getAuthorization() { + + if (username == null && password == null) { + return Optional.empty(); + } + + if (username == null || username.isEmpty()) { + logger.error("Username is null while the password is not correctly set"); + return Optional.empty(); + } + + if (password == null || password.isEmpty()) { + logger.error("Password is null while the username is not correctly set"); + return Optional.empty(); + } + + String auth = String.format("%s:%s", username, password); + return Optional.ofNullable("Basic " + base64Encoder.encodeToString(auth.getBytes())); + } + + /** + * @{inheritDoc} + */ + @Override + public boolean isAlive(Server server) { + + String url = null; + + // If unable to ping the port then return immediately + if (!pingPort(server)) { + return false; + } + + if (server.getPort() == HTTPS_PORT) { + url = "https://"; + } else { + + url = "http://"; + } + + url = url + server.getId(); + url = url + this.getHealthCheckEndpoint(); + + boolean isAlive = false; + + Optional authorization = getAuthorization(); + + HttpHeaders httpHeaders = new HttpHeaders(); + httpHeaders.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON)); + + if (authorization.isPresent()) { + httpHeaders.add("Authorization", authorization.get()); + } + + HttpEntity httpEntity = new HttpEntity<>(httpHeaders); + try { + + ResponseEntity responseEntity = restTemplate.exchange(url, HttpMethod.GET, httpEntity, String.class); + + HttpStatus httpStatus = responseEntity.getStatusCode(); + + if (httpStatus == HttpStatus.OK) { + isAlive = true; + logger.info("Successfully established connection to the following url {}", url); + return isAlive; + } + + logger.warn("Unable to establish a connection the following url {} due to HTTP Code {}, and reason {}", + url, httpStatus.value(), httpStatus.getReasonPhrase()); + + } catch (HttpClientErrorException ex) { + HttpStatus httpStatus = ex.getStatusCode(); + if (httpStatus == HttpStatus.FORBIDDEN) { + // This is a workaround being in play for the topics + // that are unable to read themselves for this user + // In the case of the username and password being + // wrong the response would be unauthorized (401) but if the + // user is authorized but unable to read this topic, then + // we get back the (403) with the message mrstatus 4002 + // This is a temporary workaround to properly identify which server is down + String body = ex.getResponseBodyAsString(); + if (body.matches(MR_STATUS_PATTERN)) { + isAlive = true; + logger.info("Successfully connected by workaround due to unable to read own topic {}", url); + return isAlive; + } else { + logger.warn("Unable to establish a connection to {} due to {}", server.getHostPort(), ex.getMessage()); + } + } else { + logger.warn("Unable to establish a connection to {} due to {}", server.getHostPort(), ex.getMessage()); + } + } catch (Exception ex) { + logger.warn("Unable to establish a connection to {} due to {}", server.getHostPort(), ex.getMessage()); + } + + return isAlive; + } + + /** + * Returns true if it can connect to the host and port within + * the given timeout from the given server parameter + * + * @param server - server that will be taken from the src/main/resources/application.yml file + * @return true if it can make a successful socket connection to the port on the host + */ + public boolean pingPort(Server server) { + + String host = server.getHost(); + Integer port = server.getPort(); + + boolean success = false; + SocketAddress socketAddress = new InetSocketAddress(host, port); + + try (Socket socket = new Socket()) { + socket.connect(socketAddress, timeout * 1000); + if (socket.isConnected()) { + success = true; + } + } catch (IOException e) { + logger.warn("Unable to connect to the host {} on port {} due to {}", host, port, e.getLocalizedMessage()); + success = false; + } + + return success; + } +} diff --git a/aai-core/pom.xml b/aai-core/pom.xml index 27b54ed8..6e525a79 100644 --- a/aai-core/pom.xml +++ b/aai-core/pom.xml @@ -13,17 +13,16 @@ 1.2.1-SNAPSHOT jar - https://nexus.onap.org + v12 + https://wiki.onap.org/ + 1.0.2 java jacoco ${project.build.directory}/surefire-reports ${project.build.directory}/coverage-reports/jacoco.exec false ${project.version} - org/onap/aai/domain/** - v12 - https://wiki.onap.org/ - 1.0.2 + 4.5.1 2.2.3 @@ -142,7 +141,165 @@ + + autoGenerate + + true + + + + + org.codehaus.mojo + exec-maven-plugin + 1.1.1 + + + autoGenerateYaml + process-classes + + java + + + org.onap.aai.util.GenerateXsd + + + gen_version + ALL + + + gen_type + YAML + + + yamlresponses_url + ${aai.wiki.link} + + + yamlresponses_label + Response codes found in [response codes] + + + + + + autoGenerateHtml + process-classes + + java + + + org.onap.aai.util.AutoGenerateHtml + + + aai.generate.version + ${gendoc.version} + + + aai.wiki.link + ${aai.wiki.link} + + + + + + + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + 2.12.4 + + -noverify ${argLine} + + . + bundleconfig-local + + + + + org.codehaus.mojo + sonar-maven-plugin + 3.2 + + + org.jacoco + jacoco-maven-plugin + 0.7.7.201606060606 + + true + + + + jacoco-initialize-unit-tests + + prepare-agent + + + ${project.build.directory}/coverage-reports/jacoco.exec + + + + + post-unit-test + test + + report + + + + ${project.build.directory}/coverage-reports/jacoco.exec + + ${project.reporting.outputDirectory}/jacoco + + + + + + maven-source-plugin + + + attach-sources + deploy + + jar-no-fork + + + + + + + org.apache.maven.plugins + maven-deploy-plugin + + + org.sonatype.plugins + nexus-staging-maven-plugin + + + org.apache.maven.plugins + maven-site-plugin + + + org.apache.maven.plugins + maven-surefire-plugin + 2.12.4 + + -noverify ${argLine} + alphabetical + + . + bundleconfig-local + + + + + + org.onap.aai.aai-common @@ -154,30 +311,22 @@ commons-lang 2.6 - - org.apache.commons - commons-text - 1.1 - compile - + + org.apache.commons + commons-text + 1.1 + compile + com.att.eelf eelf-core 1.0.0 - - jdk.tools - jdk.tools - 1.8.0_101 - system - ${JAVA_HOME}/lib/tools.jar - org.codehaus.jackson jackson-core-asl 1.9.13 - org.codehaus.jackson jackson-mapper-asl @@ -437,11 +586,11 @@ dmaapClient 0.2.12 - - com.att.aft - dme2 - - + + com.att.aft + dme2 + + org.apache.camel @@ -460,78 +609,17 @@ 1.4.0 test - - - - - - org.codehaus.mojo - sonar-maven-plugin - 3.2 - - - org.jacoco - jacoco-maven-plugin - 0.7.7.201606060606 - - true - - **/domain/** - - - - - jacoco-initialize-unit-tests - - prepare-agent - - - ${project.build.directory}/coverage-reports/jacoco.exec - - - - - post-unit-test - test - - report - - - - ${project.build.directory}/coverage-reports/jacoco.exec - - ${project.reporting.outputDirectory}/jacoco - - - - - - org.apache.maven.plugins - maven-site-plugin - - - org.apache.maven.plugins - maven-surefire-plugin - 2.12.4 - - -noverify ${argLine} - alphabetical - - . - bundleconfig-local - - - - - org.apache.maven.plugins - maven-deploy-plugin - - - org.sonatype.plugins - nexus-staging-maven-plugin - - - + + org.apache.httpcomponents + httpclient + ${httpclient.version} + + + org.onap.aai.aai-common + aai-client-loadbalancer + ${project.version} + + diff --git a/aai-core/src/main/java/org/onap/aai/config/DmaapConfig.java b/aai-core/src/main/java/org/onap/aai/config/DmaapConfig.java new file mode 100644 index 00000000..313775d9 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/config/DmaapConfig.java @@ -0,0 +1,110 @@ +/** + * ============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.config; + +import org.apache.activemq.ActiveMQConnectionFactory; +import org.apache.activemq.broker.BrokerService; +import org.apache.activemq.command.ActiveMQQueue; +import org.onap.aai.dmaap.JMSConsumer; +import org.onap.aai.dmaap.JMSProducer; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; +import org.springframework.jms.connection.CachingConnectionFactory; +import org.springframework.jms.core.JmsTemplate; +import org.springframework.jms.listener.DefaultMessageListenerContainer; + +import javax.annotation.PostConstruct; + +@Profile("dmaap") +@Configuration +public class DmaapConfig { + + @Value("${jms.bind.address}") + private String bindAddress; + + @PostConstruct + public void init(){ + System.setProperty("activemq.tcp.url", bindAddress); + } + + @Bean(destroyMethod = "stop") + public BrokerService brokerService() throws Exception { + + BrokerService broker = new BrokerService(); + broker.addConnector(bindAddress); + broker.setPersistent(false); + broker.setUseJmx(false); + broker.setSchedulerSupport(false); + broker.start(); + + return broker; + } + + @Bean(name = "connectionFactory") + public ActiveMQConnectionFactory activeMQConnectionFactory(){ + return new ActiveMQConnectionFactory(bindAddress); + } + + @Bean + public CachingConnectionFactory cachingConnectionFactory(){ + return new CachingConnectionFactory(activeMQConnectionFactory()); + } + + @Bean(name = "destinationQueue") + public ActiveMQQueue activeMQQueue(){ + return new ActiveMQQueue("IN_QUEUE"); + } + + @Bean + public JmsTemplate jmsTemplate(){ + JmsTemplate jmsTemplate = new JmsTemplate(); + + jmsTemplate.setConnectionFactory(activeMQConnectionFactory()); + jmsTemplate.setDefaultDestination(activeMQQueue()); + + return jmsTemplate; + } + + @Bean + public JMSProducer jmsProducer(){ + return new JMSProducer(); + } + + @Bean + public JMSConsumer jmsConsumer() throws Exception { + return new JMSConsumer(); + } + + @Bean + public DefaultMessageListenerContainer defaultMessageListenerContainer() throws Exception { + + DefaultMessageListenerContainer messageListenerContainer = new DefaultMessageListenerContainer(); + + messageListenerContainer.setConnectionFactory(cachingConnectionFactory()); + messageListenerContainer.setDestinationName("IN_QUEUE"); + messageListenerContainer.setMessageListener(jmsConsumer()); + + return messageListenerContainer; + } +} diff --git a/aai-core/src/main/java/org/onap/aai/config/SpringContextAware.java b/aai-core/src/main/java/org/onap/aai/config/SpringContextAware.java new file mode 100644 index 00000000..4ab9373a --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/config/SpringContextAware.java @@ -0,0 +1,42 @@ +/** + * ============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.config; + +import org.springframework.beans.BeansException; +import org.springframework.context.ApplicationContext; +import org.springframework.context.ApplicationContextAware; +import org.springframework.stereotype.Component; + +@Component +public class SpringContextAware implements ApplicationContextAware { + + private static ApplicationContext context = null; + + public static ApplicationContext getApplicationContext() { + return context; + } + + @Override + public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { + context = applicationContext; + } +} 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 914042d4..a034b9fb 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 @@ -24,20 +24,24 @@ package org.onap.aai.dmaap; import org.apache.activemq.ActiveMQConnectionFactory; import org.apache.activemq.command.ActiveMQQueue; import org.json.JSONObject; +import org.onap.aai.config.SpringContextAware; import org.onap.aai.util.AAIConfig; +import org.springframework.context.ApplicationContext; import org.springframework.jms.connection.CachingConnectionFactory; import org.springframework.jms.core.JmsTemplate; -public class AAIDmaapEventJMSProducer { +public class AAIDmaapEventJMSProducer implements MessageProducer { private JmsTemplate jmsTemplate; + private ApplicationContext applicationContext; + public AAIDmaapEventJMSProducer() { if(AAIConfig.get("aai.jms.enable", "true").equals("true")){ - this.jmsTemplate = new JmsTemplate(); - 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")); + this.jmsTemplate = new JmsTemplate(); + String activeMqTcpUrl = System.getProperty("activemq.tcp.url", "tcp://localhost:61547"); + 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/dmaap/JMSConsumer.java b/aai-core/src/main/java/org/onap/aai/dmaap/JMSConsumer.java new file mode 100644 index 00000000..b7638876 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/dmaap/JMSConsumer.java @@ -0,0 +1,160 @@ +/** + * ============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.dmaap; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import org.apache.log4j.MDC; +import org.json.JSONException; +import org.json.JSONObject; +import org.onap.aai.config.SpringContextAware; +import org.onap.aai.logging.LoggingContext.LoggingField; +import org.onap.aai.logging.LoggingContext.StatusCode; +import org.springframework.cloud.client.ServiceInstance; +import org.springframework.cloud.client.loadbalancer.LoadBalancerClient; +import org.springframework.core.env.Environment; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.MediaType; +import org.springframework.web.client.RestTemplate; + +import javax.jms.JMSException; +import javax.jms.Message; +import javax.jms.MessageListener; +import javax.jms.TextMessage; +import java.util.Base64; +import java.util.Collections; + +public class JMSConsumer implements MessageListener { + + private static final EELFLogger LOGGER = EELFManager.getInstance().getLogger(JMSConsumer.class); + + private static final int HTTPS_PORT = 3905; + private static final Base64.Encoder base64Encoder = Base64.getEncoder(); + + private HttpHeaders httpHeaders; + private RestTemplate restTemplate; + + private Environment environment; + private LoadBalancerClient loadBalancerClient; + + public JMSConsumer() throws Exception { + this((LoadBalancerClient)SpringContextAware.getApplicationContext().getBean("loadBalancerClient")); + } + + public JMSConsumer(LoadBalancerClient loadBalancerClient) throws Exception { + this.loadBalancerClient = loadBalancerClient; + this.httpHeaders = new HttpHeaders(); + this.httpHeaders.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON)); + this.environment = SpringContextAware.getApplicationContext().getEnvironment(); + + String username = this.environment.getProperty("dmaap.ribbon.username"); + String password = this.environment.getProperty("dmaap.ribbon.password"); + + if(username == null || password == null){ + throw new Exception("Unable to retrive username/password from the application properties"); + } + + String auth = String.format("%s:%s", username, password); + String authString = "Basic " + base64Encoder.encodeToString(auth.getBytes()); + httpHeaders.add("Authorization", authString); + + restTemplate = new RestTemplate(); + } + + @Override + public void onMessage(Message message) { + + String jsmMessageTxt = ""; + String aaiEvent = ""; + String eventName = ""; + + String environment = System.getProperty("lrmRO"); + if (environment == null) { + environment = ""; + } + + if (message instanceof TextMessage) { + try { + jsmMessageTxt = ((TextMessage) message).getText(); + JSONObject jo = new JSONObject(jsmMessageTxt); + + if (jo.has("aaiEventPayload")) { + aaiEvent = jo.getJSONObject("aaiEventPayload").toString(); + } else { + return; + } + if (jo.getString("transId") != null) { + MDC.put("requestId", jo.getString("transId")); + } + if (jo.getString("fromAppId") != null) { + MDC.put("partnerName", jo.getString("fromAppId")); + } + 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); + + HttpEntity httpEntity = new HttpEntity<>(aaiEvent, httpHeaders); + ServiceInstance serviceInstance = loadBalancerClient.choose("dmaap"); + String url = serviceInstance.getHost() + ":" + serviceInstance.getPort(); + + if(serviceInstance.getPort() == HTTPS_PORT){ + url = "https://" + url; + } else { + url = "http://" + url; + } + + url += "/events/" + eventName; + + if ("AAI-EVENT".equals(eventName)) { + restTemplate.exchange(url, HttpMethod.POST, httpEntity, String.class); + LOGGER.info(eventName + "|Event sent."); + } else if ("AAI-VCE-INTERFACE-DATA".equals(eventName)) { + restTemplate.exchange(url, HttpMethod.POST, httpEntity, String.class); + String msg = ""; + LOGGER.info(eventName + "|Event sent. " + msg); + } else { + MDC.put(LoggingField.STATUS_CODE.toString(), StatusCode.ERROR.toString()); + MDC.put(LoggingField.RESPONSE_CODE.toString(), "900"); + LOGGER.error(eventName + "|Event Topic invalid."); + } + } 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 jms 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); + } + } + + } + +} \ No newline at end of file diff --git a/aai-core/src/main/java/org/onap/aai/dmaap/JMSProducer.java b/aai-core/src/main/java/org/onap/aai/dmaap/JMSProducer.java new file mode 100644 index 00000000..6dbfbb77 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/dmaap/JMSProducer.java @@ -0,0 +1,58 @@ +/** + * ============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.dmaap; + +import org.apache.activemq.ActiveMQConnectionFactory; +import org.apache.activemq.command.ActiveMQQueue; +import org.json.JSONObject; +import org.onap.aai.config.SpringContextAware; +import org.onap.aai.util.AAIConfig; +import org.springframework.context.ApplicationContext; +import org.springframework.jms.connection.CachingConnectionFactory; +import org.springframework.jms.core.JmsTemplate; + +public class JMSProducer implements MessageProducer { + + private JmsTemplate jmsTemplate; + + private ApplicationContext applicationContext; + + public JMSProducer() { + if(AAIConfig.get("aai.jms.enable", "true").equals("true")){ + applicationContext = SpringContextAware.getApplicationContext(); + if(applicationContext == null){ + this.jmsTemplate = new JmsTemplate(); + String activeMqTcpUrl = System.getProperty("activemq.tcp.url", "tcp://localhost:61547"); + this.jmsTemplate.setConnectionFactory(new CachingConnectionFactory(new ActiveMQConnectionFactory(activeMqTcpUrl))); + this.jmsTemplate.setDefaultDestination(new ActiveMQQueue("IN_QUEUE")); + } else { + jmsTemplate = (JmsTemplate) applicationContext.getBean("jmsTemplate"); + } + } + } + + public void sendMessageToDefaultDestination(JSONObject finalJson) { + if(jmsTemplate != null){ + jmsTemplate.convertAndSend(finalJson.toString()); + } + } +} diff --git a/aai-core/src/main/java/org/onap/aai/dmaap/MessageProducer.java b/aai-core/src/main/java/org/onap/aai/dmaap/MessageProducer.java new file mode 100644 index 00000000..229ba1a5 --- /dev/null +++ b/aai-core/src/main/java/org/onap/aai/dmaap/MessageProducer.java @@ -0,0 +1,29 @@ +/** + * ============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.dmaap; + +import org.json.JSONObject; + +public interface MessageProducer { + + void sendMessageToDefaultDestination(JSONObject finalJson); +} 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 c670e946..524dcbf0 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 @@ -21,6 +21,8 @@ */ package org.onap.aai.introspection; +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; import org.eclipse.persistence.dynamic.DynamicType; import org.eclipse.persistence.jaxb.JAXBContextProperties; import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext; @@ -42,6 +44,7 @@ public class ModelInjestor { private Map versionContextMap = new HashMap<>(); private static final Pattern classNamePattern = Pattern.compile("\\.(v\\d+)\\."); private static final Pattern uriPattern = Pattern.compile("(v\\d+)\\/"); + private static final EELFLogger LOGGER = EELFManager.getInstance().getLogger(ModelInjestor.class); /** @@ -90,8 +93,24 @@ public class ModelInjestor { */ private void injestModel (Version version) throws JAXBException, FileNotFoundException { String fileName = this.getOXMFileName(version); - InputStream iStream = new FileInputStream(new File(fileName)); - Map properties = new HashMap(); + + File oxmFile = new File(AAIConstants.AAI_HOME_ETC + fileName); + + // Check if the file exists on the path and if it doesn't exist then + // Using classloader makes it easy to have a different oxm file + // for unit testing the oxm files otherwise, you will be + // stuck with using the main oxm for even the testing + + InputStream iStream; + if(oxmFile.exists()){ + LOGGER.info("Oxm file exists on the system {}", oxmFile); + iStream = new FileInputStream(oxmFile); + } else { + LOGGER.warn("Unable to find oxm file {} on the system so using classloader", oxmFile); + iStream = getClass().getClassLoader().getResourceAsStream(fileName); + } + + Map properties = new HashMap(); properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, iStream); final DynamicJAXBContext jaxbContext = DynamicJAXBContextFactory.createContextFromOXM(this.getClass().getClassLoader(), properties); versionContextMap.put(version, jaxbContext); @@ -168,7 +187,13 @@ public class ModelInjestor { } public String getOXMFileName(Version v) { - return AAIConstants.AAI_HOME_ETC_OXM + "aai_oxm_" + v.toString() + ".xml"; + // Changed the /oxm/aai_oxm_*.xml to oxm/aai_oxm_*.xml + // Modified to load from input stream using getClass().getClassLoader() + // As this will be able to relatively get the oxm if the oxm file is there + // So if there is a src/main/resources/oxm/ and src/test/resources/oxm, the + // test oxm will end up being used for tests and src oxm for source files + // Don't change this unless you understand the details specified + return "oxm/aai_oxm_" + v.toString() + ".xml"; } } 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 56ad2dc2..a2a673ec 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 @@ -34,6 +34,7 @@ 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.util.AAIConstants; import org.onap.aai.workarounds.NamingExceptions; import org.w3c.dom.Document; import org.w3c.dom.NodeList; @@ -46,8 +47,7 @@ import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.transform.stream.StreamSource; -import java.io.IOException; -import java.io.StringReader; +import java.io.*; import java.util.HashSet; import java.util.Map; import java.util.Set; @@ -176,7 +176,19 @@ public class MoxyLoader extends Loader { docFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); final DocumentBuilder docBuilder = docFactory.newDocumentBuilder(); - final Document doc = docBuilder.parse(fileName); + + InputStream inputStream; + File oxmFile = new File(AAIConstants.AAI_HOME_ETC + fileName); + + if(oxmFile.exists()){ + LOGGER.info("Oxm file exists on the system {}", oxmFile); + inputStream = new FileInputStream(oxmFile); + } else { + LOGGER.warn("Unable to find oxm file {} on the system so using classloader", oxmFile); + inputStream = getClass().getClassLoader().getResourceAsStream(fileName); + } + + final Document doc = docBuilder.parse(inputStream); final NodeList list = doc.getElementsByTagName("java-type"); for (int i = 0; i < list.getLength(); i++) { 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 e458c4f9..68869909 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 @@ -21,13 +21,6 @@ */ package org.onap.aai.util; -import java.util.List; -import java.util.Map; - -import org.apache.cxf.helpers.CastUtils; -import org.apache.cxf.message.Message; -import org.apache.cxf.phase.PhaseInterceptorChain; - import org.onap.aai.exceptions.AAIException; import org.onap.aai.introspection.Version; @@ -42,20 +35,20 @@ public class AAIApiServerURLBase { public static String get() throws AAIException { String hostName = null; - try { - Message message = PhaseInterceptorChain.getCurrentMessage(); - Map> headers = CastUtils.cast((Map) message.get(Message.PROTOCOL_HEADERS)); - List sa = null; - if (headers != null) { - sa = headers.get("host"); - } - - if (sa != null && sa.size() == 1) { - hostName = "https://"+ sa.get(0).toString() + "/aai/"; - } - } catch (Exception e) { - // TODO: we may want to log an error here - } +// try { +// Message message = PhaseInterceptorChain.getCurrentMessage(); +// Map> headers = CastUtils.cast((Map) message.get(Message.PROTOCOL_HEADERS)); +// List sa = null; +// if (headers != null) { +// sa = headers.get("host"); +// } +// +// if (sa != null && sa.size() == 1) { +// hostName = "https://"+ sa.get(0).toString() + "/aai/"; +// } +// } catch (Exception e) { +// // TODO: we may want to log an error here +// } // TODO: should this check the value a little closer and look for a pattern? if (hostName == null) { hostName = AAIConfig.get(AAIConstants.AAI_SERVER_URL_BASE); diff --git a/aai-core/src/main/java/org/onap/aai/util/AAICSVWriter.java b/aai-core/src/main/java/org/onap/aai/util/AAICSVWriter.java deleted file mode 100644 index c091fc24..00000000 --- a/aai-core/src/main/java/org/onap/aai/util/AAICSVWriter.java +++ /dev/null @@ -1,168 +0,0 @@ -/** - * ============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.IOException; -import java.io.PrintWriter; -import java.io.Writer; - -import com.opencsv.CSVWriter; - -/** - * had to overwrite the separate character to separate string - * Based on the public - A very simple CSV writer released under a commercial-friendly license. - * - - */ -public class AAICSVWriter extends CSVWriter { - - private String separatorStr; - private char overridequotechar; - private String overridelineEnd; - private Writer rawWriter; - private PrintWriter pw; - - /** - * Instantiates a new AAICSV writer. - * - * @param writer the writer - */ - public AAICSVWriter(Writer writer) { - super(writer); - // TODO Auto-generated constructor stub - } - - /** - * Constructs AAICSVWriter with supplied separator string and quote char. - * - * @param writer the writer to an underlying CSV source. - * @param overrideseparator the overrideseparator - * @param quotechar the character to use for quoted elements - * @param lineEnd the line feed terminator to use - */ - public AAICSVWriter(Writer writer, String overrideseparator, char quotechar, String lineEnd) { - super(writer, CSVWriter.DEFAULT_SEPARATOR, quotechar, DEFAULT_ESCAPE_CHARACTER, lineEnd); - separatorStr = overrideseparator; - overridequotechar = quotechar; - overridelineEnd = lineEnd; - this.rawWriter = writer; - this.pw = new PrintWriter(writer); - } - - /** - * String contains special characters. - * - * @param line the line - * @return true, if successful - */ - private boolean stringContainsSpecialCharacters(String line) { - return line.indexOf(overridequotechar) != -1 || line.indexOf(DEFAULT_ESCAPE_CHARACTER) != -1 || line.indexOf(separatorStr) != -1 || line.contains("\n") || line.contains("\r"); - } - - /** - * Close the underlying stream writer flushing any buffered content. - * - * @throws IOException if bad things happen - */ - public void close() throws IOException { - flush(); - pw.close(); - rawWriter.close(); - } - - /** - * Writes the next line to the file. - * - * @param nextLine a string array with each comma-separated element as a separate - * entry. - * @param applyQuotesToAll true if all values are to be quoted. false applies quotes only - * to values which contain the separator, escape, quote or new line characters. - */ - public void writeNext(String[] nextLine, boolean applyQuotesToAll) { - - if (nextLine == null) - return; - - StringBuilder sb = new StringBuilder(INITIAL_STRING_SIZE); - for (int i = 0; i < nextLine.length; i++) { - - if (i != 0) { - sb.append(separatorStr); - } - - String nextElement = nextLine[i]; - - if (nextElement == null) - continue; - - Boolean stringContainsSpecialCharacters = stringContainsSpecialCharacters(nextElement); - - if ((applyQuotesToAll || stringContainsSpecialCharacters) && overridequotechar != NO_QUOTE_CHARACTER) - sb.append(overridequotechar); - - if (stringContainsSpecialCharacters) { - sb.append(processLine(nextElement)); - } else { - sb.append(nextElement); - } - - if ((applyQuotesToAll || stringContainsSpecialCharacters) && overridequotechar != NO_QUOTE_CHARACTER) - sb.append(overridequotechar); - } - - sb.append(overridelineEnd); - pw.write(sb.toString()); - } - - - /** - * Writes the next line to the file ignoring all exceptions. - * - * @param nextLine a string array with each comma-separated element as a separate - * entry. - */ - public void writeColumn(String[] nextLine) { - - if (nextLine == null) - return; - - StringBuilder sb = new StringBuilder(INITIAL_STRING_SIZE); - for (int i = 0; i < nextLine.length; i++) { - - - String nextElement = nextLine[i]; - - if (nextElement == null) - continue; - - sb.append(nextElement); - - - } - - sb.append(overridelineEnd); - pw.write(sb.toString()); - } -} 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 57bf2cc7..6f904970 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 @@ -52,8 +52,6 @@ public class AAIConfig { // this (probably) won't change between releases, put it in the config if it gets annoying... private static HashMap> defaultBools = new HashMap>(); - private static Timer timer = new Timer(); - /** * Instantiates a new AAI config. */ @@ -122,13 +120,6 @@ public class AAIConfig { return defaultBools; } - /** - * Cleanup. - */ - public static void cleanup() { - timer.cancel(); - } - /** * Gets the config file. * 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 0ad33cb9..2a64e996 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 @@ -27,35 +27,70 @@ import java.util.UUID; import javax.xml.bind.Marshaller; +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; import org.eclipse.persistence.dynamic.DynamicEntity; import org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContext; import org.json.JSONException; import org.json.JSONObject; +import org.onap.aai.config.SpringContextAware; import org.onap.aai.dmaap.AAIDmaapEventJMSProducer; +import org.onap.aai.dmaap.JMSProducer; +import org.onap.aai.dmaap.MessageProducer; import org.onap.aai.domain.notificationEvent.NotificationEvent; 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.springframework.beans.factory.NoSuchBeanDefinitionException; +import org.springframework.context.ApplicationContext; +import org.springframework.core.env.Environment; public class StoreNotificationEvent { - private AAIDmaapEventJMSProducer messageProducer; + private static final EELFLogger logger = EELFManager.getInstance().getLogger(StoreNotificationEvent.class); + private MessageProducer messageProducer; private String fromAppId = ""; private String transId = ""; private final String transactionId; private final String sourceOfTruth; + + private ApplicationContext context; + private Environment env; + /** * Instantiates a new store notification event. */ public StoreNotificationEvent(String transactionId, String sourceOfTruth) { - this(new AAIDmaapEventJMSProducer(), transactionId, sourceOfTruth); + this.context = SpringContextAware.getApplicationContext(); + // If the context is null then this is being invoked from + // non spring context so creating the jms producer each time + // Otherwise, get the jms producer from the spring context so + // no need to create a instance of this each time + // Also check if the environment has the dmaap profile + // TODO - Add the constants for profile so do this when adding the https two-way ssl and one way with basic auth + if(this.context == null){ + this.messageProducer = new AAIDmaapEventJMSProducer(); + } else { + env = context.getEnvironment(); + if(env.acceptsProfiles("dmaap")){ + try { + this.messageProducer = (JMSProducer)context.getBean("jmsProducer"); + } catch(NoSuchBeanDefinitionException ex){ + logger.error("Currently using the dmaap profile but still not able to find bean so check DmaapConfig", ex); + } + } else { + this.messageProducer = new AAIDmaapEventJMSProducer(); + } + } + this.transactionId = transactionId; + this.sourceOfTruth = sourceOfTruth; } - + public StoreNotificationEvent(AAIDmaapEventJMSProducer producer, String transactionId, String sourceOfTruth) { - this.messageProducer = producer; - this.transactionId = transactionId; - this.sourceOfTruth = sourceOfTruth; + this.messageProducer = producer; + this.transactionId = transactionId; + this.sourceOfTruth = sourceOfTruth; } /** 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 7d3cafac..65a241f0 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 @@ -261,7 +261,7 @@ public class DataCopyTest { private String getJsonString(String filename) throws IOException { - FileInputStream is = new FileInputStream("src/test/resources/bundleconfig-local/etc/oxm/sideeffect/" + filename); + FileInputStream is = new FileInputStream("src/test/resources/oxm/sideeffect/" + filename); String s = IOUtils.toString(is, "UTF-8"); IOUtils.closeQuietly(is); 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 deleted file mode 100644 index b149e95f..00000000 --- a/aai-core/src/test/java/org/onap/aai/util/AAICSVWriterTest.java +++ /dev/null @@ -1,77 +0,0 @@ -/** - * ============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/StoreNotificationEventTest.java b/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java index 5c87b29e..0050c101 100644 --- a/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java +++ b/aai-core/src/test/java/org/onap/aai/util/StoreNotificationEventTest.java @@ -151,7 +151,7 @@ public class StoreNotificationEventTest extends AAISetup { 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"); + InputStream is = cl.getResourceAsStream("oxm/aai_oxm_v11.xml"); Map properties = new HashMap(); properties.put(JAXBContextProperties.OXM_METADATA_SOURCE, is); DynamicJAXBContext notificationJaxbContextReal = DynamicJAXBContextFactory.createContextFromOXM(cl, properties); diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v10.xml b/aai-core/src/test/resources/oxm/aai_oxm_v10.xml similarity index 100% rename from aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v10.xml rename to aai-core/src/test/resources/oxm/aai_oxm_v10.xml diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v11.xml b/aai-core/src/test/resources/oxm/aai_oxm_v11.xml similarity index 100% rename from aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v11.xml rename to aai-core/src/test/resources/oxm/aai_oxm_v11.xml diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml b/aai-core/src/test/resources/oxm/aai_oxm_v12.xml similarity index 99% rename from aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml rename to aai-core/src/test/resources/oxm/aai_oxm_v12.xml index 2364cf82..4eff665e 100644 --- a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v12.xml +++ b/aai-core/src/test/resources/oxm/aai_oxm_v12.xml @@ -5139,13 +5139,13 @@ - - - - - - - + + + + + + + diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v8.xml b/aai-core/src/test/resources/oxm/aai_oxm_v8.xml similarity index 100% rename from aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v8.xml rename to aai-core/src/test/resources/oxm/aai_oxm_v8.xml diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v9.xml b/aai-core/src/test/resources/oxm/aai_oxm_v9.xml similarity index 100% rename from aai-core/src/test/resources/bundleconfig-local/etc/oxm/aai_oxm_v9.xml rename to aai-core/src/test/resources/oxm/aai_oxm_v9.xml diff --git a/aai-core/src/test/resources/bundleconfig-local/etc/oxm/sideeffect/nested-case.json b/aai-core/src/test/resources/oxm/sideeffect/nested-case.json similarity index 100% rename from aai-core/src/test/resources/bundleconfig-local/etc/oxm/sideeffect/nested-case.json rename to aai-core/src/test/resources/oxm/sideeffect/nested-case.json diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html index 16503665..5c6001cc 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v10.html @@ -1,4 +1,3 @@ - @@ -15,8 +14,11 @@

Active and Available Inventory REST API.

-

Version: v11

-

Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+

Version: v12

+


+[Differences versus the previous schema version](apidocs/aai_swagger_v10.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.

@@ -62,6 +64,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -82,6 +89,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -112,6 +124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -142,6 +159,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -172,6 +194,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -202,6 +229,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -222,6 +254,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -252,6 +289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -292,6 +334,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -322,6 +369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -352,6 +404,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -372,6 +429,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -387,6 +449,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -412,6 +479,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -452,6 +524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -482,6 +559,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -497,6 +579,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -522,6 +609,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -572,6 +664,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -602,6 +699,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -632,6 +734,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -652,6 +759,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -692,6 +804,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -722,6 +839,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}

create or update an existing pserver

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

update an existing pserver

@@ -742,6 +864,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -762,6 +889,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -777,6 +909,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -802,6 +939,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -842,6 +984,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -872,6 +1019,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -887,6 +1039,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -912,6 +1069,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -962,6 +1124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -982,6 +1149,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -997,6 +1169,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1022,6 +1199,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1062,6 +1244,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1092,6 +1279,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1107,6 +1299,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1132,6 +1329,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1192,6 +1394,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1236,6 +1443,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /business/connectors/connector/{resource-instance-id}

create or update an existing connector

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

update an existing connector

@@ -1256,6 +1468,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1286,6 +1503,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /business/customers/customer/{global-customer-id}

create or update an existing customer

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

update an existing customer

@@ -1316,6 +1538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1346,6 +1573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1366,6 +1598,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1396,6 +1633,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1426,6 +1668,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1470,6 +1717,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1490,6 +1742,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1510,6 +1767,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1530,6 +1792,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1550,6 +1817,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1570,6 +1842,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1590,6 +1867,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1660,6 +1942,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1680,6 +1967,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1700,6 +1992,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1720,6 +2017,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1770,6 +2072,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1800,6 +2107,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1830,6 +2142,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1874,6 +2191,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1894,6 +2216,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1924,6 +2251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1939,6 +2271,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -1964,6 +2301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2004,6 +2346,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2034,6 +2381,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2049,6 +2401,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2074,6 +2431,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2114,6 +2476,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2134,6 +2501,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2149,6 +2521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2174,6 +2551,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2214,6 +2596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2244,6 +2631,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2259,6 +2651,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2284,6 +2681,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2334,6 +2736,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2374,6 +2781,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2404,6 +2816,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2434,6 +2851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2464,6 +2886,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2494,6 +2921,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2514,6 +2946,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2554,6 +2991,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2584,6 +3026,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2614,6 +3061,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2644,6 +3096,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2674,6 +3131,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2704,6 +3166,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2734,6 +3201,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /network/newvces/newvce/{vnf-id2}

create or update an existing newvce

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

update an existing newvce

@@ -2754,6 +3226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2769,6 +3246,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2794,6 +3276,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2834,6 +3321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2864,6 +3356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2879,6 +3376,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2904,6 +3406,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2954,6 +3461,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -2984,6 +3496,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /network/pnfs/pnf/{pnf-name}

create or update an existing pnf

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

update an existing pnf

@@ -3004,6 +3521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3024,6 +3546,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3039,6 +3566,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3064,6 +3596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3104,6 +3641,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3134,6 +3676,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3149,6 +3696,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3174,6 +3726,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3224,6 +3781,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3244,6 +3806,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3259,6 +3826,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3284,6 +3856,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3324,6 +3901,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3354,6 +3936,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3369,6 +3956,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3394,6 +3986,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3454,6 +4051,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3484,6 +4086,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3514,6 +4121,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3544,6 +4156,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3564,6 +4181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3604,6 +4226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /network/vces/vce/{vnf-id}

create or update an existing vce

+ + + + PATCH /network/vces/vce/{vnf-id} +

update an existing vce

@@ -3624,6 +4251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3654,6 +4286,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3684,6 +4321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3704,6 +4346,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3754,6 +4401,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /network/vnfcs/vnfc/{vnfc-name}

create or update an existing vnfc

+ + + + PATCH /network/vnfcs/vnfc/{vnfc-name} +

update an existing vnfc

@@ -3784,6 +4436,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3804,6 +4461,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3824,6 +4486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3839,6 +4506,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3864,6 +4536,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3904,6 +4581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3934,6 +4616,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3949,6 +4636,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -3974,6 +4666,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4024,6 +4721,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4044,6 +4746,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4059,6 +4766,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4084,6 +4796,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4124,6 +4841,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4154,6 +4876,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4169,6 +4896,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4194,6 +4926,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4254,6 +4991,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4284,6 +5026,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

@@ -4314,6 +5061,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /network/zones/zone/{zone-id}

create or update an existing zone

+ + + + PATCH /network/zones/zone/{zone-id} +

update an existing zone

@@ -4376,7 +5128,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /connectors + /connectors
@@ -4531,7 +5283,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /connector + /connector
@@ -4578,7 +5330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

connector object that needs to be created or updated

+

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

@@ -4648,6 +5400,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing connector
+

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

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -4868,7 +5709,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadata + /metadata
@@ -5038,7 +5879,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /metadatum
@@ -5085,7 +5926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

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

@@ -5170,6 +6011,110 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
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.

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

-

relationship object that needs to be created or updated

+

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

@@ -5480,7 +6425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /customers + /customers
@@ -5605,7 +6550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /customer + /customer
@@ -5652,7 +6597,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

customer object that needs to be created or updated

+

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

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

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

+
update an existing customer
+

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

Tags: Business
-

delete an existing customer

+

update an existing customer

application/json application/xml

+
+
+

customer object that needs to be created or updated.

+

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

resource-version for concurrency

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

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

+
delete an existing customer
+

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

Tags: Business
-

see node definition for valid relationships

+

delete an existing customer

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

resource-version for concurrency

+ 		query + string + + + +
@@ -5905,22 +6850,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

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

+
see node definition for valid relationships
+

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

Tags: Business
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
@@ -5981,19 +6938,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns service-subscriptions
-

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

+
delete an existing relationship
+

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

Tags: Business
-

returns service-subscriptions

+

delete an existing relationship

+
+ +

application/json application/xml +

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

Subscriber name, an alternate way to retrieve a customer.

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

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

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service-subscriptions -
-
-
- -
default @@ -6106,17 +7015,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns service-subscription
-

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

+
returns service-subscriptions
+

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

Tags: Business
-

returns service-subscription

+

returns service-subscriptions

@@ -6147,22 +7056,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - service-type - - -

Value defined by orchestration to identify this service across ECOMP.

- - path - - string - - - - - - subscriber-name @@ -6219,7 +7112,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /service-subscription + /service-subscriptions
@@ -6248,35 +7141,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing service-subscription
-

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

+
returns service-subscription
+

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

Tags: Business
-

create or update an existing service-subscription

+

returns service-subscription

-
- -

application/json application/xml -

-
-
-

service-subscription object that needs to be created or updated

-

-
-
-
-
- /service-subscription -
-
-
-
@@ -6321,105 +7197,27 @@ 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 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 -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /service-subscription +
+
+
+ +
default @@ -6461,17 +7281,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
create or update an existing service-subscription
+

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

Tags: Business
-

see node definition for valid relationships

+

create or update an existing service-subscription

@@ -6480,13 +7300,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

+

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

- /relationship + /service-subscription
@@ -6566,23 +7386,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
update an existing service-subscription
+

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

Tags: Business
-

delete an existing relationship

+

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 + subscriber-name -

Value defined by orchestration to identify this service across ECOMP.

+

Subscriber name, an alternate way to retrieve a customer.

pathquery string -
- resource-version + subscriber-type -

resource-version for concurrency

+

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

 query @@ -6427,7 +7225,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -6659,19 +7491,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns service-instances
-

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

+
delete an existing service-subscription
+

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

Tags: Business
-

returns service-instances

+

delete an existing service-subscription

+
+ +

application/json application/xml +

+
@@ -6718,25 +7555,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - @@ -6755,29 +7578,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service-instances -
-
-
- -
default @@ -6800,19 +7600,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns service-instance
-

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

+
see node definition for valid relationships
+

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

Tags: Business
-

returns service-instance

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

- 		query - string - - -
- subscriber-type + resource-version -

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

+

resource-version for concurrency

 query @@ -6744,6 +7566,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -6857,157 +7674,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- service-instance-id - -

Uniquely identifies this instance of a service

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

Subscriber name, an alternate way to retrieve a customer.

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

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

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

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

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

the ASDC model id for this resource or service model.

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

the ASDC model version for this resource or service model.

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

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

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

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

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

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

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

Orchestration status of this service.

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service-instance -
-
-
- -
default @@ -7062,35 +7705,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
delete an existing relationship
+

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

Tags: Business
-

create or update an existing service-instance

+

delete an existing relationship

application/json application/xml

-
-
-

service-instance object that needs to be created or updated

-

-
-
-
-
- /service-instance -
-
-
@@ -7136,22 +7767,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- service-instance-id - -

Uniquely identifies this instance of a service

- 		path - string - - - -
@@ -7183,24 +7798,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns service-instances
+

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

Tags: Business
-

delete an existing service-instance

+

returns service-instances

-
- -

application/json application/xml -

-
@@ -7247,26 +7857,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -7286,6 +7894,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /service-instances +
+
+
+ +
default @@ -7308,17 +7939,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 allotted-resources

+

returns service-instance

@@ -7542,7 +8173,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /allotted-resources + /service-instance
@@ -7570,17 +8201,646 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns allotted-resource
-

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

+
create or update an existing service-instance
+

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

Tags: Business
-

returns allotted-resource

+

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/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

+

+
+
+
+
+ /service-instance +
+
+
+
+
+
- service-instance-id + subscriber-name -

Uniquely identifies this instance of a service

+

Subscriber name, an alternate way to retrieve a customer.

pathquery string -
- resource-version + subscriber-type -

resource-version for concurrency

+

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

 query @@ -7274,7 +7883,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

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

Value defined by orchestration to identify this service across ECOMP.

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

Uniquely identifies this instance of a service

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

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

@@ -7880,7 +9140,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /allotted-resource + /allotted-resource
@@ -7927,7 +9187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

allotted-resource object that needs to be created or updated

+

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

@@ -8045,6 +9305,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing allotted-resource
+

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

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

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

-

relationship object that needs to be created or updated

+

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

@@ -8758,7 +10155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tunnel-xconnects + /tunnel-xconnects
@@ -9112,7 +10509,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tunnel-xconnect + /tunnel-xconnect
@@ -9159,7 +10556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

tunnel-xconnect object that needs to be created or updated

+

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

@@ -9294,22 +10691,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

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

delete an existing tunnel-xconnect

+

update an existing tunnel-xconnect

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /tunnel-xconnect +
+
+
@@ -9403,22 +10812,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

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

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

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

see node definition for valid relationships

+

delete an existing tunnel-xconnect

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

resource-version for concurrency

+ 		query + string + + + +
@@ -9604,22 +11001,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

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

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

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

returns metadata

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -9819,137 +11233,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -9961,29 +11272,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadata -
-
-
- -
default @@ -10006,17 +11294,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

returns metadata

@@ -10079,21 +11367,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - + + + + + + + + + + + + + +
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

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

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

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

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

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

the ASDC model id for this resource or service model.

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

the ASDC model version for this resource or service model.

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

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

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

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

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

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

+

Allotted Resource id UUID assigned to this instance.

querypath string +
- orchestration-status + id -

Orchestration status of this service.

+

Allotted Resource id UUID assigned to this instance.

querypath string +
- metaname - - path - string - - - -
subscriber-name @@ -10255,7 +11528,284 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /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 + + +
+ 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
@@ -10302,7 +11852,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

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

@@ -10419,6 +11969,142 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
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.

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

-

relationship object that needs to be created or updated

+

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

@@ -10825,7 +12511,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cloud-regions + /cloud-regions
@@ -10966,7 +12652,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cloud-region + /cloud-region
@@ -11013,7 +12699,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

cloud-region object that needs to be created or updated

+

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

@@ -11100,16 +12786,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing cloud-region
-

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

+
update an existing cloud-region
+

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

Tags: CloudInfrastructure
-

delete an existing cloud-region

+

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

@@ -11321,7 +13112,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /availability-zones + /availability-zones
@@ -11478,7 +13269,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /availability-zone + /availability-zone
@@ -11525,7 +13316,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

availability-zone object that needs to be created or updated

+

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

@@ -11627,6 +13418,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
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.

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

-

relationship object that needs to be created or updated

+

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

@@ -12095,7 +14007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /dvs-switches + /dvs-switches
@@ -12267,7 +14179,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /dvs-switch + /dvs-switch
@@ -12314,7 +14226,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

dvs-switch object that needs to be created or updated

+

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

@@ -12417,22 +14329,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing dvs-switch
-

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

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

delete an existing dvs-switch

+

update an existing dvs-switch

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /dvs-switch +
+
+
@@ -12494,22 +14418,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -12541,35 +14449,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

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

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

see node definition for valid relationships

+

delete an existing dvs-switch

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /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 + + + +
+ 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/v10/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -12884,7 +14917,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /flavors + /flavors
@@ -13056,7 +15089,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /flavor + /flavor
@@ -13103,7 +15136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

flavor object that needs to be created or updated

+

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

@@ -13205,6 +15238,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing flavor
+

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

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

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

-

relationship object that needs to be created or updated

+

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

@@ -13673,7 +15827,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /group-assignments + /group-assignments
@@ -13860,7 +16014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /group-assignment + /group-assignment
@@ -13907,7 +16061,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

group-assignment object that needs to be created or updated

+

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

@@ -14010,16 +16164,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing group-assignment
-

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

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

delete an existing group-assignment

+

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

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

-

relationship object that needs to be created or updated

+

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

@@ -14477,7 +16752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /images + /images
@@ -14694,7 +16969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /image + /image
@@ -14741,7 +17016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

image object that needs to be created or updated

+

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

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

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

+
update an existing image
+

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

Tags: CloudInfrastructure
-

delete an existing image

+

update an existing image

application/json application/xml

+
+
+

image object that needs to be created or updated.

+

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

resource-version for concurrency

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

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

+
delete an existing image
+

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

Tags: CloudInfrastructure
-

returns metadata

+

delete an existing image

+
+ +

application/json application/xml +

+
@@ -15043,85 +17319,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -15140,29 +17342,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadata -
-
-
- -
default @@ -15185,17 +17364,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns metadatum
-

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

+
returns metadata
+

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

Tags: CloudInfrastructure
-

returns metadatum

+

returns metadata

@@ -15258,21 +17437,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - + + + + + + +
- cloud-type - -

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

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

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

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

Image name

- 		query - string - - -
- application - -

The application that the image instantiates.

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

The vendor of the application.

- 		query - string - - -
- application-version + resource-version -

The version of the application.

+

resource-version for concurrency

 query @@ -15129,6 +17330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- metaname - - path - string - - - -
cloud-type @@ -15389,7 +17553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /metadata
@@ -15418,35 +17582,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing metadatum
-

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

+
returns metadatum
+

GET /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

+

returns metadatum

-
- -

application/json application/xml -

-
-
-

metadatum object that needs to be created or updated

-

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

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

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

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

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

Image name

+ 		query + string + + +
+ application + +

The application that the image instantiates.

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

The vendor of the application.

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

The version of the application.

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
default @@ -15554,22 +17814,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing metadatum
-

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

+
create or update an existing metadatum
+

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

Tags: CloudInfrastructure
-

delete an existing metadatum

+

create or update an existing metadatum

application/json application/xml

+
+
+

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

+

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

resource-version for concurrency

- 		query - string - - - -
@@ -15693,17 +17949,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

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

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

see node definition for valid relationships

+

update an existing metadatum

@@ -15712,13 +17968,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

+

metadatum object that needs to be created or updated.

- /relationship + /metadatum
@@ -15783,6 +18039,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ metaname + + path + string + + + +
@@ -15814,17 +18085,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

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

+

delete an existing metadatum

@@ -15892,6 +18163,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ metaname + + path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -15923,17 +18225,247 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns oam-networks
-

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

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

returns oam-networks

+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/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

@@ -16036,7 +18568,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /oam-networks + /oam-networks
@@ -16223,7 +18755,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /oam-network + /oam-network
@@ -16270,7 +18802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

oam-network object that needs to be created or updated

+

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

@@ -16373,22 +18905,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing oam-network
-

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

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

delete an existing oam-network

+

update an existing oam-network

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /oam-network +
+
+
@@ -16450,22 +18994,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

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

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

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

see node definition for valid relationships

+

delete an existing oam-network

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

resource-version for concurrency

+ 		query + string + + + +
@@ -16619,22 +19151,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

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

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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -16801,6 +19333,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+ 		path + string + + + +
@@ -16833,22 +19381,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
@@ -16925,19 +19485,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns snapshots
-

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

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

returns snapshots

+

delete an existing relationship

+
+ +

application/json application/xml +

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

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

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

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

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /snapshots -
-
-
- -
default @@ -17066,17 +19578,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns snapshot
-

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

+
returns snapshots
+

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

Tags: CloudInfrastructure
-

returns snapshot

+

returns snapshots

@@ -17123,22 +19635,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - snapshot-id - - -

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

- - path - - string - - - - - - cloud-type @@ -17169,81 +19665,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - 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 - - - - -
@@ -17270,7 +19691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /snapshot + /snapshots
@@ -17299,35 +19720,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing snapshot
-

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

+
returns snapshot
+

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

Tags: CloudInfrastructure
-

create or update an existing snapshot

+

returns snapshot

-
- -

application/json application/xml -

-
-
-

snapshot object that needs to be created or updated

-

-
-
-
-
- /snapshot -
-
-
-
@@ -17388,121 +19792,102 @@ 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 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 -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /snapshot +
+
+
+ +
default @@ -17544,17 +19951,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
create or update an existing snapshot
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing snapshot

@@ -17563,13 +19970,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

+

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

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

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

+
update an existing snapshot
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing snapshot

application/json application/xml

+
+
+

snapshot object that needs to be created or updated.

+

+
+
+
+
+ /snapshot +
+
+
- cloud-owner + cloud-type -

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

+

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

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

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

+

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

pathquery string -
- snapshot-id + snapshot-name -

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+

Snapshot name

pathquery string -
- resource-version + application -

resource-version for concurrency

+

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 @@ -17510,7 +19895,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -17774,19 +20193,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns tenants
-

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

+
delete an existing snapshot
+

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

Tags: CloudInfrastructure
-

returns tenants

+

delete an existing snapshot

+
+ +

application/json application/xml +

+
@@ -17833,25 +20257,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -17870,29 +20296,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /tenants -
-
-
- -
default @@ -17915,19 +20318,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns tenant
-

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

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

returns tenant

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
- cloud-type + snapshot-id -

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

+

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

querypath string +
- owner-defined-type + resource-version -

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

+

resource-version for concurrency

 query @@ -17859,6 +20284,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -17974,10 +20394,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- tenant-id + snapshot-id -

Unique id relative to the cloud-region.

+

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

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

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

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

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

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

Readable name of tenant

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /tenant -
-
-
- -
default @@ -18087,35 +20439,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing tenant
-

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

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

create or update an existing tenant

+

delete an existing relationship

application/json application/xml

-
-
-

tenant object that needs to be created or updated

-

-
-
-
-
- /tenant -
-
-
@@ -18163,10 +20503,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- tenant-id + snapshot-id -

Unique id relative to the cloud-region.

+

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

 path @@ -18208,24 +20548,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing tenant
-

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

+
returns tenants
+

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

Tags: CloudInfrastructure
-

delete an existing tenant

+

returns tenants

-
- -

application/json application/xml -

-
@@ -18272,26 +20607,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -18311,6 +20644,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

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

+
returns tenant
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns tenant

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
- tenant-id + cloud-type -

Unique id relative to the cloud-region.

+

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

pathquery string -
- resource-version + owner-defined-type -

resource-version for concurrency

+

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

 query @@ -18299,7 +20633,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -18423,6 +20762,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
+ cloud-type + +

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

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

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

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

Readable name of tenant

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /tenant +
+
+
+ +
default @@ -18454,23 +20861,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
create or update an existing tenant
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

+
+
+
+
+ /tenant +
+
+
@@ -18563,19 +20982,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vservers
-

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

+
update an existing tenant
+

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

Tags: CloudInfrastructure
-

returns vservers

+

update an existing tenant

+
+ +

application/json application/xml +

+
+
+

tenant object that needs to be created or updated.

+

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

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

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

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

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

Readable name of tenant

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vservers -
-
-
- -
default @@ -18735,19 +21103,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vserver
-

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

+
delete an existing tenant
+

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

Tags: CloudInfrastructure
-

returns vserver

+

delete an existing tenant

+
+ +

application/json application/xml +

+
@@ -18810,56 +21183,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - + +
- vserver-id - -

Unique identifier for this vserver relative to its tenant

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

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

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

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

- 		query - string - - -
- tenant-name + resource-version -

Readable name of tenant

+

resource-version for concurrency

 query @@ -18867,79 +21194,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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - @@ -18951,29 +21327,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vserver -
-
-
- -
default @@ -18996,35 +21349,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vserver
-

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

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

create or update an existing vserver

+

delete an existing relationship

application/json application/xml

-
-
-

vserver object that needs to be created or updated

-

-
-
-
-
- /vserver -
-
-
- vserver-name + cloud-owner -

Name of vserver

+

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

querypath string +
- vserver-name2 + cloud-region-id -

Alternative name of vserver

+

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

querypath string +
- prov-status + tenant-id -

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

+

Unique id relative to the cloud-region.

querypath string -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - +
@@ -19086,22 +21427,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

- 		path - string - - - -
@@ -19133,24 +21458,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vserver
-

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

+
returns vservers
+

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

Tags: CloudInfrastructure
-

delete an existing vserver

+

returns vservers

-
- -

application/json application/xml -

-
@@ -19213,26 +21533,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -19252,6 +21585,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vservers +
+
+
+ +
default @@ -19274,17 +21630,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

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

+
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 l-interfaces

+

returns vserver

@@ -19507,7 +21863,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /vserver
@@ -19535,19 +21891,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

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

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

returns l-interface

+

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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

+
+
+
+
+ /vserver +
+
+
+
- vserver-id + cloud-type -

Unique identifier for this vserver relative to its tenant

+

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

pathquery string -
- resource-version + owner-defined-type -

resource-version for concurrency

+

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

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

Readable name of tenant

 query @@ -19240,7 +21574,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -19624,12 +21997,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -19812,29 +22143,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -19857,35 +22165,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

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

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

create or update an existing l-interface

+

delete an existing vserver

application/json application/xml

-
-
-

l-interface object that needs to be created or updated

-

-
-
-
-
- /l-interface -
-
-
- interface-name + cloud-owner -

Name given to the interface

+

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

 path @@ -19642,165 +22088,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

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

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

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

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

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

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

ID of interface

+

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

querypath string +
- macaddr + tenant-id -

MAC address for the interface

+

Unique id relative to the cloud-region.

querypath string +
- network-name + vserver-id -

Name of the network

+

Unique identifier for this vserver relative to its tenant

querypath string +
@@ -19965,12 +22261,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
- interface-name + resource-version -

Name given to the interface

+

resource-version for concurrency

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

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

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

delete an existing l-interface

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -20106,26 +22397,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -20145,6 +22522,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -20167,17 +22567,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/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 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 l3-interface-ipv4-address-list

+

returns l-interface

@@ -20272,22 +22672,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + cloud-type -

Name given to the interface

+

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

pathquery string -
- resource-version + owner-defined-type -

resource-version for concurrency

+

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

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

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

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + +
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
cloud-type @@ -20451,51 +22835,6 @@ 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 - -

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 - - -
@@ -20522,7 +22861,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l-interface
@@ -20550,17 +22889,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

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

+
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 l3-interface-ipv4-address-list

+

create or update an existing l-interface

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

-

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

+

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

- /l3-interface-ipv4-address-list + /l-interface
@@ -20672,22 +23011,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -20719,190 +23042,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/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

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

see node definition for valid relationships

+

update an existing l-interface

@@ -20911,13 +23061,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

+

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

- /relationship + /l-interface
@@ -21014,22 +23164,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -21061,17 +23195,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

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

+

delete an existing l-interface

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

IP address

+

resource-version for concurrency

- path + query string @@ -21218,17 +23352,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

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

+
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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

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

IP address

@@ -21573,7 +23707,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -21601,17 +23735,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

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

+
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-ipv6-address-list

+

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

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

-

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

+

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

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

IP address

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

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

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

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

+

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

application/json application/xml

+
+
+

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

+

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

IP address

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

resource-version for concurrency

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

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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

IP address

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

resource-version for concurrency

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

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

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

IP address

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

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

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -22391,137 +24525,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /cloud-infrastructure/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 + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -22563,17 +24572,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

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

+
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 sriov-vfs

+

returns l3-interface-ipv6-address-list

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

IP address

+ 		path + string + + + +
cloud-type @@ -22831,6 +24856,51 @@ 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 + +

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 + + +
@@ -22857,7 +24927,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l3-interface-ipv6-address-list
@@ -22885,19 +24955,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

returns sriov-vf

+

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

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -22992,10 +25079,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -23006,229 +25093,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

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

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

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

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

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

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

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

- 		query - string - - -
- 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 - - -
@@ -23238,29 +25102,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -23283,17 +25124,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing sriov-vf
-

PUT /cloud-infrastructure/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 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
-

create or update an existing sriov-vf

+

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

@@ -23302,13 +25143,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

+

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

- /sriov-vf + /l3-interface-ipv6-address-list
@@ -23407,10 +25248,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -23452,17 +25293,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

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

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

+

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

@@ -23564,10 +25405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

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

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -23644,7 +25485,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -23749,10 +25590,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -23794,11 +25635,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/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
@@ -23906,10 +25747,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -23951,19 +25792,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

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

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

returns vlans

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -24056,167 +25914,145 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -24273,17 +26086,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

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

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

+

returns sriov-vfs

@@ -24378,22 +26191,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - -
- cloud-type - -

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

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

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

+

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

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

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

+

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

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

ID of interface

+

Unique id relative to the cloud-region.

querypath string +
- macaddr + vserver-id -

MAC address for the interface

+

Unique identifier for this vserver relative to its tenant

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

Name of the network

+

Name given to the interface

querypath string +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
cloud-type @@ -24557,36 +26354,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
@@ -24613,7 +26380,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /sriov-vfs
@@ -24641,36 +26408,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vlan
-

PUT /cloud-infrastructure/cloud-regions/cloud-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 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
-

create or update an existing vlan

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated

-

-
-
-
-
- /vlan -
-
-
-
@@ -24765,10 +26515,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -24779,169 +26529,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vlan
-

DELETE /cloud-infrastructure/cloud-regions/cloud-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 -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -24983,19 +26806,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

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

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

returns l3-interface-ipv4-address-list

+

create or update an existing sriov-vf

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /sriov-vf +
+
+
+
- cloud-owner + cloud-type -

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

+

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

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

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

+

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

pathquery string -
- tenant-id + tenant-name -

Unique id relative to the cloud-region.

+

Readable name of tenant

pathquery string -
- vserver-id + vserver-name -

Unique identifier for this vserver relative to its tenant

+

Name of vserver

pathquery string -
- interface-name + vserver-name2 -

Name given to the interface

+

Alternative name of vserver

pathquery string -
- vlan-interface + prov-status -

String that identifies the interface

+

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

pathquery string -
- resource-version + in-maint -

resource-version for concurrency

+ 		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 @@ -24949,7 +26750,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -25090,26 +26930,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

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

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -25120,244 +26944,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

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

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

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

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

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

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

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

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

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

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

Inner VLAN tag

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

Neutron network id of the interface that address belongs to

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

Neutron id of subnet that address belongs to

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -25412,17 +26975,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

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

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

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

+

update an existing sriov-vf

@@ -25431,13 +26994,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

+

sriov-vf object that needs to be created or updated.

- /l3-interface-ipv4-address-list + /sriov-vf
@@ -25536,26 +27099,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

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

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -25597,17 +27144,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/cloud-regions/cloud-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 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 l3-interface-ipv4-address-list

+

delete an existing sriov-vf

@@ -25709,26 +27256,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

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

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -25786,11 +27317,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -25805,7 +27336,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -25910,26 +27441,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

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

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -25971,11 +27486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
@@ -26083,26 +27598,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

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

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -26144,17 +27643,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

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

+
returns 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 l3-interface-ipv6-address-list

+

returns vlans

@@ -26249,38 +27748,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
cloud-type @@ -26444,81 +27911,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

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 - - -
@@ -26545,7 +27937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /vlans
@@ -26573,36 +27965,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

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

+
returns vlan
+

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

Tags: CloudInfrastructure
-

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

+

returns vlan

-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -26713,199 +28088,188 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- l3-interface-ipv6-address + cloud-type -

IP address

+

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

pathquery 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 -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -26947,17 +28333,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

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

see node definition for valid relationships

+

create or update an existing vlan

@@ -26966,13 +28352,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

+

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

- /relationship + /vlan
@@ -27085,22 +28471,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- cloud-owner + owner-defined-type -

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

+

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

pathquery string -
- cloud-region-id + tenant-name -

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

+

Readable name of tenant

pathquery string -
- tenant-id + vserver-name -

Unique id relative to the cloud-region.

+

Name of vserver

pathquery string -
- vserver-id + vserver-name2 -

Unique identifier for this vserver relative to its tenant

+

Alternative name of vserver

pathquery string -
- interface-name + prov-status -

Name given to the interface

+

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

pathquery string -
- vlan-interface + in-maint -

String that identifies the interface

pathquery + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+ 		query string -
- l3-interface-ipv6-address + macaddr -

IP address

+

MAC address for the interface

pathquery string -
- resource-version + network-name -

resource-version for concurrency

+

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 @@ -26913,7 +28277,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- l3-interface-ipv6-address - -

IP address

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

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

+
update an existing vlan
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

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

IP address

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

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

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

see node definition for valid relationships

+

delete an existing vlan

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

resource-version for concurrency

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

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

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

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -27600,117 +28965,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

PUT /cloud-infrastructure/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

-

-
-
-
-
- /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 + l3-interface-ipv4-address -

Unique id relative to the cloud-region.

+

IP address

 path @@ -27723,271 +28983,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-id - -

Unique identifier for this vserver relative to its tenant

- 		path - string - - - -
-
- -
-

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 + cloud-type -

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

+

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

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

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

+

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

pathquery string -
- tenant-id + tenant-name -

Unique id relative to the cloud-region.

+

Readable name of tenant

pathquery string -
- vserver-id + vserver-name -

Unique identifier for this vserver relative to its tenant

+

Name of vserver

pathquery 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 + vserver-name2 -

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

+

Alternative name of vserver

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

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

+

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

pathquery string -
- tenant-id + in-maint -

Unique id relative to the cloud-region.

pathquery - string + boolean -
- vserver-id + is-closed-loop-disabled -

Unique identifier for this vserver relative to its tenant

pathquery - string + boolean -
- cloud-type + interface-id -

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

+

ID of interface

 query @@ -27999,10 +29116,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + macaddr -

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

+

MAC address for the interface

 query @@ -28014,10 +29131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-name + network-name -

Readable name of tenant

+

Name of the network

 query @@ -28029,14 +29146,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-name + vlan-id-inner -

Name of vserver

+

Inner VLAN tag

 query - string + integer @@ -28044,10 +29161,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-name2 + vpn-id -

Alternative name of vserver

+

This indicates the customers VPN ID associated with this vlan

 query @@ -28059,14 +29176,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vlan-id-inner -

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

+

Inner VLAN tag

 query - string + integer @@ -28074,13 +29191,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + neutron-network-id +

Neutron network id of the interface that address belongs to

 query - boolean + string @@ -28088,13 +29206,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + neutron-subnet-id +

Neutron id of subnet that address belongs to

 query - boolean + string @@ -28126,7 +29245,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /volumes + /l3-interface-ipv4-address-list
@@ -28154,19 +29273,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume
-

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

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

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

Tags: CloudInfrastructure
-

returns volume

+

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

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -28245,10 +29381,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - @@ -28386,29 +29436,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volume -
-
-
- -
default @@ -28431,17 +29458,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing volume
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

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

create or update an existing volume

+

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

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

-

volume object that needs to be created or updated

+

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

- /volume + /l3-interface-ipv4-address-list
@@ -28539,10 +29566,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - -
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

 path @@ -28261,120 +29397,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type - -

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

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

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

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

Readable name of tenant

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

Name of vserver

- 		query - string - - -
- vserver-name2 + vlan-interface -

Alternative name of vserver

+

String that identifies the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

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

+

IP address

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

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

IP address

 path @@ -28584,17 +29643,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing volume
-

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

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

+

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

@@ -28680,10 +29739,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

IP address

 path @@ -28741,11 +29832,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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
@@ -28760,7 +29851,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -28849,10 +29940,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

IP address

 path @@ -28894,11 +30017,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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
@@ -28990,10 +30113,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

IP address

 path @@ -29035,17 +30190,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume-groups
-

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

+
returns 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 volume-groups

+

returns l3-interface-ipv6-address-list

@@ -29094,119 +30249,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type + tenant-id -

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

+

Unique id relative to the cloud-region.

querypath string +
- owner-defined-type + vserver-id -

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

+

Unique identifier for this vserver relative to its tenant

querypath 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 + interface-name -

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

+

Name given to the interface

 path @@ -29219,10 +30297,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + vlan-interface -

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

+

String that identifies the interface

 path @@ -29235,10 +30313,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + l3-interface-ipv6-address -

Unique ID of volume-group.

+

IP address

 path @@ -29281,10 +30359,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-name + tenant-name -

Name of the volume group.

+

Readable name of tenant

 query @@ -29296,10 +30374,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vserver-name -

Heat stack id corresponding to this volume-group

+

Name of vserver

 query @@ -29311,10 +30389,173 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + vserver-name2 -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Alternative name of vserver

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

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

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

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

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

Name of the network

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

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

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

Inner VLAN tag

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

Neutron network id of the interface that address belongs to

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

Neutron id of subnet that address belongs to

 query @@ -29350,7 +30591,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /volume-group + /l3-interface-ipv6-address-list
@@ -29378,17 +30619,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing volume-group
-

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

+
create or update an existing 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 volume-group

+

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

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

-

volume-group object that needs to be created or updated

+

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

- /volume-group + /l3-interface-ipv6-address-list
@@ -29454,10 +30695,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

Unique id relative to the cloud-region.

 path @@ -29468,73 +30709,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + vserver-id -

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

+

Unique identifier for this vserver relative to its tenant

 path @@ -29547,10 +30727,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + interface-name -

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

+

Name given to the interface

 path @@ -29563,10 +30743,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + vlan-interface -

Unique ID of volume-group.

+

String that identifies the interface

 path @@ -29579,12 +30759,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -29624,17 +30804,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

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

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

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

@@ -29643,13 +30823,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

+

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

- /relationship + /l3-interface-ipv6-address-list
@@ -29700,10 +30880,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

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 @@ -29745,17 +30989,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

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

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

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

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

@@ -29809,10 +31053,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

Unique id relative to the cloud-region.

 path @@ -29823,132 +31067,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /complex -
-
-
- -
default @@ -30058,17 +31178,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing complex
-

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

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

create or update an existing complex

+

see node definition for valid relationships

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

-

complex object that needs to be created or updated

+

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

- /complex + /relationship
@@ -30102,10 +31222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
- physical-location-id + vserver-id -

Unique identifier for physical location, e.g., CLLI

+

Unique identifier for this vserver relative to its tenant

 path @@ -29961,40 +31085,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code + interface-name -

Data center code which can be an alternate way to identify a complex

+

Name given to the interface

querypath string +
- complex-name + vlan-interface -

Gamma complex name for LCP instance.

+

String that identifies the interface

querypath string +
- identity-url + l3-interface-ipv6-address -

URL of the keystone identity service

+

IP address

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

resource-version for concurrency

 query @@ -30002,6 +31144,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30116,73 +31236,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing complex
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing complex

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - -
- physical-location-id + cloud-region-id -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30195,12 +31254,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + tenant-id -

resource-version for concurrency

+

Unique id relative to the cloud-region.

querypath string @@ -30209,68 +31268,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns ctag-pools
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns ctag-pools

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-pools -
-
-
- -
default @@ -30380,19 +31363,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pool
-

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

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

returns ctag-pool

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- physical-location-id + vserver-id -

Unique identifier for physical location, e.g., CLLI

+

Unique identifier for this vserver relative to its tenant

 path @@ -30283,47 +31286,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code + interface-name -

Data center code which can be an alternate way to identify a complex

+

Name given to the interface

querypath string +
- complex-name + vlan-interface -

Gamma complex name for LCP instance.

+

String that identifies the interface

querypath string +
- identity-url + l3-interface-ipv6-address -

URL of the keystone identity service

+

IP address

querypath string +
@@ -30407,10 +31395,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -30507,29 +31514,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-pool -
-
-
- -
default @@ -30552,17 +31536,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing ctag-pool
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

create or update an existing ctag-pool

+

see node definition for valid relationships

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

-

ctag-pool object that needs to be created or updated

+

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

- /ctag-pool + /relationship
@@ -30596,10 +31580,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30423,10 +31411,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

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

 path @@ -30439,10 +31427,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

 path @@ -30455,47 +31443,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code + vserver-id -

Data center code which can be an alternate way to identify a complex

+

Unique identifier for this vserver relative to its tenant

querypath string +
- complex-name + interface-name -

Gamma complex name for LCP instance.

+

Name given to the interface

querypath string +
- identity-url + vlan-interface -

URL of the keystone identity service

+

String that identifies the interface

querypath + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30612,10 +31596,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

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

 path @@ -30628,10 +31612,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

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 @@ -30673,17 +31705,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing ctag-pool
-

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

+
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 ctag-pool

+

delete an existing relationship

@@ -30705,10 +31737,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30721,10 +31753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

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

 path @@ -30737,10 +31769,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

 path @@ -30753,12 +31785,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vserver-id -

resource-version for concurrency

+

Unique identifier for this vserver relative to its tenant

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

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string @@ -30798,11 +31862,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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
@@ -30817,7 +31881,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -30842,10 +31906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30858,10 +31922,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

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

 path @@ -30874,10 +31938,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

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

Unique identifier for this vserver relative to its tenant

 path @@ -30919,11 +31999,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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
@@ -30951,10 +32031,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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

 path @@ -30967,10 +32047,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

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

 path @@ -30983,10 +32063,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

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

Unique identifier for this vserver relative to its tenant

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

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

+
returns volumes
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns volumes

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -31072,10 +32151,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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 @@ -31086,6 +32213,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ cloud-type + +

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

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

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

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

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

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volumes +
+
+
+ +
default @@ -31117,24 +32385,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
returns volume
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns volume

-
- -

application/json application/xml -

-
@@ -31149,10 +32412,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

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 @@ -31163,51 +32490,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ cloud-type + +

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

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

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

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

Readable name of tenant

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

Name of vserver

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

Alternative name of vserver

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

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

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
-
-

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

@@ -31230,7 +32634,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-profiles + /volume
@@ -31258,19 +32662,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns network-profile
-

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

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

returns network-profile

+

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/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

+
+
+
+
+ /volume +
+
+
+
@@ -31285,10 +32706,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

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 @@ -31308,29 +32793,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /network-profile -
-
-
- -
default @@ -31353,17 +32815,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing network-profile
-

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

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

create or update an existing network-profile

+

update an existing volume

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

-

network-profile object that needs to be created or updated

+

volume object that needs to be created or updated.

- /network-profile + /volume
@@ -31397,10 +32859,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

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 @@ -31442,17 +32968,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing network-profile
-

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

+
delete an existing 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 network-profile

+

delete an existing volume

@@ -31474,10 +33000,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

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 @@ -31535,11 +33125,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -31554,7 +33144,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -31579,10 +33169,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

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 @@ -31624,11 +33278,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -31656,10 +33310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

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

 path @@ -31670,79 +33324,79 @@ 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 pservers
-

GET /cloud-infrastructure/pservers

- Tags: - CloudInfrastructure -
-
-
-

returns pservers

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /pservers -
-
-
- -
default @@ -31765,17 +33419,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns pserver
-

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

+
returns volume-groups
+

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

Tags: CloudInfrastructure
-

returns pserver

+

returns volume-groups

@@ -31792,10 +33446,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + cloud-owner -

Value from executing hostname on the compute node.

+

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

 path @@ -31808,25 +33462,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + cloud-region-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

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

querypath string +
- pserver-id + cloud-type -

ID of Pserver

+

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

 query @@ -31838,24 +33493,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- pserver-name2 + owner-defined-type -

alternative pserver name

+

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

 query @@ -31891,7 +33532,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pserver + /volume-groups
@@ -31919,36 +33560,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing pserver
-

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

+
returns volume-group
+

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

Tags: CloudInfrastructure
-

create or update an existing pserver

+

returns volume-group

-
- -

application/json application/xml -

-
-
-

pserver object that needs to be created or updated

-

-
-
-
-
- /pserver -
-
-
-
@@ -31963,10 +33587,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- hostname + cloud-owner -

Value from executing hostname on the compute node.

+

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

 path @@ -31977,73 +33601,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing pserver
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing pserver

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - -
- hostname + cloud-region-id -

Value from executing hostname on the compute node.

+

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

 path @@ -32056,12 +33619,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + volume-group-id -

resource-version for concurrency

+

Unique ID of volume-group.

querypath string @@ -32070,84 +33633,27 @@ 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 lag-interfaces
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns lag-interfaces

- -
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - -
- hostname + cloud-type -

Value from executing hostname on the compute node.

+

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

pathquery string -
- inv-status + owner-defined-type -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

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

 query @@ -32159,10 +33665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + volume-group-name -

ID of Pserver

+

Name of the volume group.

 query @@ -32174,13 +33680,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + heat-stack-id +

Heat stack id corresponding to this volume-group

 query - boolean + string @@ -32188,10 +33695,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + vnf-type -

alternative pserver name

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query @@ -32227,7 +33734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /volume-group
@@ -32255,19 +33762,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interface
-

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

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

returns lag-interface

+

create or update an existing volume-group

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /volume-group +
+
+
+
@@ -32282,10 +33806,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -32410,29 +33861,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interface -
-
-
- -
default @@ -32455,17 +33883,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

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

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

create or update an existing lag-interface

+

update an existing volume-group

@@ -32474,13 +33902,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

+

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

- /lag-interface + /volume-group
@@ -32499,10 +33927,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- hostname + cloud-owner -

Value from executing hostname on the compute node.

+

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

 path @@ -32298,10 +33822,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cloud-region-id -

Name that identifies the link aggregate interface

+

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

 path @@ -32314,91 +33838,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + volume-group-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Unique ID of volume-group.

querypath string +
- hostname + cloud-owner -

Value from executing hostname on the compute node.

+

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

 path @@ -32515,10 +33943,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cloud-region-id -

Name that identifies the link aggregate interface

+

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

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -32560,17 +34004,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

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

+
delete an existing 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 lag-interface

+

delete an existing volume-group

@@ -32592,10 +34036,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + cloud-owner -

Value from executing hostname on the compute node.

+

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

 path @@ -32608,10 +34052,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cloud-region-id -

Name that identifies the link aggregate interface

+

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

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -32669,19 +34129,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -32696,10 +34173,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- hostname + cloud-owner -

Value from executing hostname on the compute node.

+

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

 path @@ -32712,10 +34189,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cloud-region-id -

Name that identifies the link aggregate interface

+

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

 path @@ -32728,97 +34205,174 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id + volume-group-id -

ID of Pserver

+

Unique ID of volume-group.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - + - + - +
- in-maint - - query - boolean - - -
- pserver-name2 + cloud-owner -

alternative pserver name

+

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

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

ID of interface

+

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

querypath string +
- interface-role + volume-group-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Unique ID of volume-group.

querypath 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

@@ -32841,7 +34395,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /complexes
@@ -32869,17 +34423,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

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

+
returns complex
+

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

Tags: CloudInfrastructure
-

returns l-interface

+

returns complex

@@ -32896,42 +34450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

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

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + physical-location-id -

Name given to the interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -32944,99 +34466,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id + data-center-code -

ID of interface

+

Data center code which can be an alternate way to identify a complex

 query @@ -33048,10 +34481,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + complex-name -

MAC address for the interface

+

Gamma complex name for LCP instance.

 query @@ -33063,10 +34496,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + identity-url -

Name of the network

+

URL of the keystone identity service

 query @@ -33102,7 +34535,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /complex
@@ -33130,17 +34563,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

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

+
create or update an existing complex
+

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

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

create or update an existing complex

@@ -33149,13 +34582,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

+

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

- /l-interface + /complex
@@ -33174,42 +34607,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

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

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + physical-location-id -

Name given to the interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -33251,23 +34652,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

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

+
update an existing complex
+

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

Tags: CloudInfrastructure
-

delete an existing l-interface

+

update an existing complex

application/json application/xml

+
+
+

complex object that needs to be created or updated.

+

+
+
+
+
+ /complex +
+
+
@@ -33283,42 +34696,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

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

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + physical-location-id -

Name given to the interface

+

Unique identifier for physical location, e.g., CLLI

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

resource-version for concurrency

- 		query - string - - - -
@@ -33376,19 +34741,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing complex
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

delete an existing complex

+
+ +

application/json application/xml +

+
@@ -33403,10 +34773,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -33419,12 +34789,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name that identifies the link aggregate interface

+

resource-version for concurrency

pathquery string @@ -33433,217 +34803,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

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

IP address

- 		path - string - - - -
- 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 - - -
@@ -33653,29 +34812,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -33698,36 +34834,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

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

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

Tags: CloudInfrastructure
-

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

+

returns ctag-pools

-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -33742,10 +34861,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -33813,6 +34929,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-pools +
+
+
+ +
default @@ -33835,24 +34974,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns ctag-pool
+

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

Tags: CloudInfrastructure
-

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

+

returns ctag-pool

-
- -

application/json application/xml -

-
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -33758,50 +34877,47 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + data-center-code -

Name that identifies the link aggregate interface

+

Data center code which can be an alternate way to identify a complex

pathquery string -
- interface-name + complex-name -

Name given to the interface

+

Gamma complex name for LCP instance.

pathquery string -
- l3-interface-ipv4-address + identity-url -

IP address

+

URL of the keystone identity service

pathquery string -
@@ -33867,10 +35001,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -33954,6 +35101,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-pool +
+
+
+ +
default @@ -33976,17 +35146,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
create or update an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing ctag-pool

@@ -33995,13 +35165,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

+

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

- /relationship + /ctag-pool
@@ -34020,26 +35190,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - + + + + + + +
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -33883,10 +35017,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name that identifies the link aggregate interface

+

The Target provider edge router

 path @@ -33899,10 +35033,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + availability-zone-name -

Name given to the interface

+

Name of the availability zone

 path @@ -33915,26 +35049,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + data-center-code -

IP address

+

Data center code which can be an alternate way to identify a complex

pathquery string -
- resource-version + complex-name -

resource-version for concurrency

+

Gamma complex name for LCP instance.

+ 		query + string + + +
+ identity-url + +

URL of the keystone identity service

 query @@ -33942,7 +35090,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name + physical-location-id -

Name that identifies the link aggregate interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34052,10 +35206,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name given to the interface

+

The Target provider edge router

 path @@ -34068,10 +35222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + availability-zone-name -

IP address

+

Name of the availability zone

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

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

+
update an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing ctag-pool

application/json application/xml

+
+
+

ctag-pool object that needs to be created or updated.

+

+
+
+
+
+ /ctag-pool +
+
+
@@ -34145,26 +35311,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name + physical-location-id -

Name that identifies the link aggregate interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34177,10 +35327,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name given to the interface

+

The Target provider edge router

 path @@ -34193,10 +35343,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + availability-zone-name -

IP address

+

Name of the availability zone

 path @@ -34238,19 +35388,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

delete an existing ctag-pool

+
+ +

application/json application/xml +

+
@@ -34265,26 +35420,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -34515,29 +35491,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

+

see node definition for valid relationships

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

-

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

+

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

- /l3-interface-ipv6-address-list + /relationship
@@ -34604,26 +35557,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name + physical-location-id -

Name that identifies the link aggregate interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34297,10 +35436,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name given to the interface

+

The Target provider edge router

 path @@ -34313,10 +35452,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

 path @@ -34329,174 +35468,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

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

Inner VLAN tag

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

Neutron network id of the interface that address belongs to

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

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -34504,6 +35479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name + physical-location-id -

Name that identifies the link aggregate interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34636,10 +35573,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name given to the interface

+

The Target provider edge router

 path @@ -34652,10 +35589,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

 path @@ -34697,17 +35634,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing 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 l3-interface-ipv6-address-list

+

delete an existing relationship

@@ -34729,26 +35666,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name + physical-location-id -

Name that identifies the link aggregate interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34761,10 +35682,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name given to the interface

+

The Target provider edge router

 path @@ -34777,10 +35698,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

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

resource-version for concurrency

- 		query - string - - - -
@@ -34838,11 +35743,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

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

+

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

Tags: CloudInfrastructure
@@ -34857,7 +35762,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -34882,58 +35787,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

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

Name that identifies the link aggregate interface

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

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address + physical-location-id -

IP address

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34975,11 +35832,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: CloudInfrastructure
@@ -35007,58 +35864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

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

Name that identifies the link aggregate interface

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

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address + physical-location-id -

IP address

+

Unique identifier for physical location, e.g., CLLI

 path @@ -35100,105 +35909,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
returns network-profiles
+

GET /cloud-infrastructure/network-profiles

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns network-profiles

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /network-profiles +
+
+
+ +
default @@ -35221,24 +35973,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
returns network-profile
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns network-profile

-
- -

application/json application/xml -

-
@@ -35253,10 +36000,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- hostname + nm-profile-name -

Value from executing hostname on the compute node.

+

Unique name of network profile.

 path @@ -35267,12 +36014,108 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)

+

+
+
+
+
+ /network-profile +
+
+
+
+
+ + + + + + + + + + + + +
- interface-name + nm-profile-name -

Name that identifies the link aggregate interface

+

Unique name of network profile.

 path @@ -35283,12 +36126,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + nm-profile-name -

Name given to the interface

+

Unique name of network profile.

 path @@ -35330,19 +36246,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

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

+
delete an existing network-profile
+

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

Tags: CloudInfrastructure
-

returns sriov-vfs

+

delete an existing network-profile

+
+ +

application/json application/xml +

+
@@ -35357,10 +36278,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- hostname + nm-profile-name -

Value from executing hostname on the compute node.

+

Unique name of network profile.

 path @@ -35373,12 +36294,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name that identifies the link aggregate interface

+

resource-version for concurrency

pathquery string @@ -35387,12 +36308,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + +
- interface-name + nm-profile-name -

Name given to the interface

+

Unique name of network profile.

 path @@ -35403,144 +36397,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 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name + nm-profile-name -

Name of the network

+

Unique name of network profile.

querypath 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

@@ -35563,7 +36541,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /pservers
@@ -35591,17 +36569,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

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

+
returns pserver
+

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

Tags: CloudInfrastructure
-

returns sriov-vf

+

returns pserver

@@ -35632,54 +36610,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

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

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
inv-status @@ -35739,141 +36669,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -35900,7 +36695,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /pserver
@@ -35928,17 +36723,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing sriov-vf
-

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

+
create or update an existing pserver
+

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

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

create or update an existing pserver

@@ -35947,13 +36742,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

+

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

- /sriov-vf + /pserver
@@ -35986,54 +36781,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

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

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -36065,23 +36812,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing sriov-vf
-

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

+
update an existing pserver
+

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

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

update an existing pserver

application/json application/xml

+
+
+

pserver object that needs to be created or updated.

+

+
+
+
+
+ /pserver +
+
+
@@ -36111,70 +36870,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name that identifies the link aggregate interface

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

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

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

resource-version for concurrency

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

PUT /cloud-infrastructure/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 pserver
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing pserver

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -36266,44 +36949,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + - - - - - - - - + + + + + + + +
- interface-name - -

Name that identifies the link aggregate interface

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

Name given to the interface

- 		path - string - - - -
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
returns lag-interfaces
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns lag-interfaces

-
- -

application/json application/xml -

-
@@ -36391,50 +37037,61 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -36446,6 +37103,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
default @@ -36468,17 +37148,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

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

+
returns lag-interface
+

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

Tags: CloudInfrastructure
-

returns vlans

+

returns lag-interface

@@ -36525,22 +37205,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + inv-status -

Name that identifies the link aggregate interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- interface-name + pserver-id -

Name given to the interface

+

ID of Pserver

pathquery string -
- pci-id + in-maint -

PCI ID used to identify the sriov-vf

pathquery + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query string -
- interface-name - -

Name given to the interface

- 		path - string - - - -
inv-status @@ -36630,51 +37294,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

- 		query - string - - -
@@ -36701,7 +37320,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /lag-interface
@@ -36729,19 +37348,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

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

+
create or update an existing lag-interface
+

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

Tags: CloudInfrastructure
-

returns vlan

+

create or update an existing lag-interface

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /lag-interface +
+
+
+
@@ -36786,12 +37422,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing 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 given to the interface

+

Name that identifies the link aggregate interface

 path @@ -36802,12 +37527,193 @@ 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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing lag-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface + hostname -

String that identifies the interface

+

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 @@ -36907,6 +37813,192 @@ 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 /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 @@ -36924,10 +38016,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + interface-role -

MAC address for the interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -36939,10 +38031,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-id -

Name of the network

+

ID of interface

 query @@ -36954,14 +38046,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + macaddr -

Inner VLAN tag

+

MAC address for the interface

 query - integer + string @@ -36969,10 +38061,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + network-name -

This indicates the customers VPN ID associated with this vlan

+

Name of the network

 query @@ -37008,7 +38100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l-interface
@@ -37036,17 +38128,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

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

+
create or update an existing 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 vlan

+

create or update an existing l-interface

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

-

vlan object that needs to be created or updated

+

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

- /vlan + /l-interface
@@ -37126,22 +38218,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -37173,23 +38249,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vlan
-

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

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

delete an existing vlan

+

update an existing l-interface

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /l-interface +
+
+
@@ -37251,12 +38339,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing 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 + + + +
- vlan-interface + interface-name -

String that identifies the interface

+

Name that identifies the link aggregate interface

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

Name given to the interface

 path @@ -37314,11 +38495,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
@@ -37387,22 +38568,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -37568,36 +38733,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

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

Inner VLAN tag

- 		query - integer - - -
neutron-network-id @@ -37654,7 +38789,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -37682,11 +38817,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
@@ -37701,7 +38836,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -37774,10 +38909,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

+ 		path + 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 @@ -37835,11 +39091,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
@@ -37913,22 +39169,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -37992,11 +39232,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

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
@@ -38011,7 +39251,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -38082,22 +39322,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -38145,11 +39369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
@@ -38223,22 +39447,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -38286,11 +39494,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
@@ -38359,22 +39567,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -38540,36 +39732,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

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

Inner VLAN tag

- 		query - integer - - -
neutron-network-id @@ -38626,7 +39788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -38654,11 +39816,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
@@ -38673,7 +39835,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -38744,163 +39906,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
-
- -
-

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 @@ -38917,22 +39922,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -38964,17 +39953,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships

+

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

@@ -38983,13 +39972,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

+

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

- /relationship + /l3-interface-ipv6-address-list
@@ -39054,22 +40043,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -39117,17 +40090,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 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 relationship

+

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

@@ -39197,10 +40170,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -39213,12 +40186,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -39258,11 +40231,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/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
@@ -39277,7 +40250,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -39350,10 +40323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -39395,11 +40368,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/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
@@ -39475,10 +40448,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -39520,11 +40493,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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

Tags: CloudInfrastructure
@@ -39539,7 +40512,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -39594,6 +40567,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
@@ -39625,11 +40614,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

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

+

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

Tags: CloudInfrastructure
@@ -39687,6 +40676,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
@@ -39718,17 +40723,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns p-interfaces
-

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

+
returns sriov-vfs
+

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

Tags: CloudInfrastructure
-

returns p-interfaces

+

returns sriov-vfs

@@ -39759,6 +40764,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

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

Name given to the interface

+ 		path + string + + + +
inv-status @@ -39818,6 +40855,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -39844,7 +40956,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interfaces + /sriov-vfs
@@ -39872,17 +40984,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns p-interface
-

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

+
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 p-interface

+

returns sriov-vf

@@ -39918,7 +41030,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

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 @@ -39990,10 +41134,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

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

+

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 @@ -40029,7 +41293,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interface + /sriov-vf
@@ -40057,17 +41321,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing p-interface
-

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

+
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 p-interface

+

create or update an existing sriov-vf

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

-

p-interface object that needs to be created or updated

+

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

- /p-interface + /sriov-vf
@@ -40120,84 +41384,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

- 		path - string - - - -
-
- -
-

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.

+

Name that identifies the link aggregate interface

 path @@ -40213,7 +41400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

+

Name given to the interface

 path @@ -40226,12 +41413,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -40271,19 +41458,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

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

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

returns l-interfaces

+

update an existing sriov-vf

+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
@@ -40317,7 +41521,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - + - + @@ -40411,29 +41573,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -40456,19 +41595,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

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

+
delete an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

returns l-interface

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -40330,76 +41534,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name given to the interface

querypath string +
- prov-status + pci-id -

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

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -40502,7 +41646,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -40657,29 +41714,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -40702,17 +41736,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

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

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

see node definition for valid relationships

@@ -40721,13 +41755,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

+

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

- /l-interface + /relationship
@@ -40765,7 +41799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -40531,114 +41675,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

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

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

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr + pci-id -

MAC address for the interface

+

PCI ID used to identify the sriov-vf

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

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

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -40792,6 +41826,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -40823,17 +41873,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

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

+
delete an existing 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 l-interface

+

delete an existing relationship

@@ -40874,7 +41924,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -40903,12 +41953,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -40948,17 +41998,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns vlans
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

returns vlans

@@ -40994,7 +42044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -41023,26 +42073,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + inv-status -

IP address

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- inv-status + pserver-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of Pserver

 query @@ -41054,14 +42103,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + in-maint -

ID of Pserver

 query - string + boolean @@ -41069,13 +42117,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + pserver-name2 +

alternative pserver name

 query - boolean + string @@ -41083,10 +42132,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + interface-id -

alternative pserver name

+

ID of interface

 query @@ -41098,10 +42147,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-role -

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

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -41156,51 +42205,6 @@ 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 - -

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 - - -
@@ -41227,7 +42231,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vlans
@@ -41255,36 +42259,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

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

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

+

returns vlan

-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -41318,7 +42305,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -41347,10 +42334,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 @@ -41361,137 +42348,161 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - CloudInfrastructure -
-
-
-

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

- -
-
- -

application/json application/xml -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -41533,17 +42566,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
create or update an existing vlan
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing vlan

@@ -41552,13 +42585,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

+

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

- /relationship + /vlan
@@ -41596,7 +42629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- hostname + inv-status -

Value from executing hostname on the compute node.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- interface-name + pserver-id -

Name that identifies the physical interface

+

ID of Pserver

pathquery string -
- interface-name + in-maint -

Name given to the interface

pathquery + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query string -
- l3-interface-ipv4-address + interface-id -

IP address

+

ID of interface

pathquery string -
- resource-version + interface-role -

resource-version for concurrency

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

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

Name of the network

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

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

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

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -41625,10 +42658,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 @@ -41670,23 +42703,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

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

+
update an existing vlan
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -41721,7 +42766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -41750,10 +42795,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 @@ -41795,19 +42840,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing vlan
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

delete an existing vlan

+
+ +

application/json application/xml +

+
@@ -41841,7 +42891,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -41870,7 +42920,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ 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

@@ -41945,10 +43147,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

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

+

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -42018,6 +43235,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

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

Inner VLAN tag

+ 		query + integer + + +
neutron-network-id @@ -42074,7 +43321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -42102,17 +43349,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

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

+

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

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

-

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

+

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

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -42165,7 +43412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42194,7 +43441,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

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

IP address

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

DELETE /cloud-infrastructure/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-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
-

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

+

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

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -42290,7 +43565,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42319,10 +43594,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 @@ -42335,12 +43610,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

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

PUT /cloud-infrastructure/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 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
-

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -42443,7 +43706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42472,7 +43735,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

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

IP address

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

resource-version for concurrency

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

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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
@@ -42568,7 +43875,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42597,7 +43904,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

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

IP address

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

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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -42705,7 +44016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42732,89 +44043,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/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 + vlan-interface -

Name that identifies the physical interface

+

String that identifies the interface

 path @@ -42827,10 +44061,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -42872,17 +44106,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

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

+
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 sriov-vfs

+

returns l3-interface-ipv6-address-list

@@ -42918,7 +44152,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42947,43 +44181,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + vlan-interface -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

String that identifies the interface

querypath string +
- pserver-id + l3-interface-ipv6-address -

ID of Pserver

+

IP address

querypath string +
- in-maint + inv-status +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query - boolean + string @@ -42991,10 +44228,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + pserver-id -

alternative pserver name

+

ID of Pserver

 query @@ -43006,10 +44243,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + in-maint -

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

+ 		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 @@ -43064,6 +44345,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

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 + + +
@@ -43090,7 +44446,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l3-interface-ipv6-address-list
@@ -43118,19 +44474,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

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

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

returns sriov-vf

+

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

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -43164,7 +44537,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -43395,29 +44605,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -43440,17 +44627,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

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

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

create or update an existing sriov-vf

+

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

@@ -43459,13 +44646,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

+

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

- /sriov-vf + /l3-interface-ipv6-address-list
@@ -43503,7 +44690,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -43193,10 +44566,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -43209,181 +44582,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id - -

ID of Pserver

- 		query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

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

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

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

- 		query - string - - -
- 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 + l3-interface-ipv6-address -

Neutron network id of the interface

+

IP address

querypath string +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -43532,10 +44719,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -43577,17 +44780,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

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

+
delete an existing 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 sriov-vf

+

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

@@ -43628,7 +44831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -43657,10 +44860,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -43718,11 +44937,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/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
@@ -43737,7 +44956,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

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

@@ -43781,7 +45000,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -43810,10 +45029,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -43855,11 +45090,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/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
@@ -43906,7 +45141,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -43935,10 +45170,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -43980,19 +45231,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

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

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

returns vlans

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -44026,7 +45294,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -44055,121 +45323,248 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + vlan-interface -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - + - + - + + +
- pserver-id + hostname -

ID of Pserver

+

Value from executing hostname on the compute node.

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the link aggregate 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 +
- interface-id + vlan-interface -

ID of interface

+

String that identifies the interface

querypath 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/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + @@ -44181,29 +45576,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -44226,19 +45598,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

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

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

returns vlan

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- macaddr + hostname -

MAC address for the interface

+

Value from executing hostname on the compute node.

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

Name of the network

+

Name that identifies the link aggregate interface

querypath string +
@@ -44272,7 +45649,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -44283,12 +45660,68 @@ 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 p-interfaces
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + - + + +
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

 path @@ -44301,26 +45734,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + inv-status -

String that identifies the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- inv-status + pserver-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of Pserver

 query @@ -44332,14 +45764,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + in-maint -

ID of Pserver

 query - string + boolean @@ -44347,54 +45778,136 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + pserver-name2 +

alternative pserver name

 query - boolean + 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

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - -
- pserver-name2 + hostname -

alternative pserver name

+

Value from executing hostname on the compute node.

querypath string +
- prov-status + interface-name -

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

+

Name that identifies the physical interface

querypath string +
- interface-id + inv-status -

ID of interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -44406,10 +45919,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + pserver-id -

MAC address for the interface

+

ID of Pserver

 query @@ -44421,14 +45934,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + in-maint -

Name of the network

 query - string + boolean @@ -44436,14 +45948,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + pserver-name2 -

Inner VLAN tag

+

alternative pserver name

 query - integer + string @@ -44451,10 +45963,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + prov-status -

This indicates the customers VPN ID associated with this vlan

+

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

 query @@ -44490,7 +46002,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /p-interface
@@ -44518,17 +46030,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

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

+
create or update an existing p-interface
+

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

Tags: CloudInfrastructure
-

create or update an existing vlan

+

create or update an existing p-interface

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

-

vlan object that needs to be created or updated

+

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

- /vlan + /p-interface
@@ -44592,38 +46104,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -44655,23 +46135,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vlan
-

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

+
update an existing p-interface
+

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

Tags: CloudInfrastructure
-

delete an existing vlan

+

update an existing p-interface

application/json application/xml

+
+
+

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

+

+
+
+
+
+ /p-interface +
+
+
@@ -44717,12 +46209,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

+
+
+ + + + + + + + + + + - + - + - + + +
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

 path @@ -44735,10 +46288,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 that identifies the physical interface

 path @@ -44796,17 +46349,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interfaces
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

returns l-interfaces

@@ -44855,58 +46408,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + inv-status -

Name given to the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- vlan-interface + pserver-id -

String that identifies the interface

+

ID of Pserver

pathquery string -
- l3-interface-ipv4-address + in-maint -

IP address

pathquery - string + boolean -
- inv-status + pserver-name2 -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

alternative pserver name

 query @@ -44918,10 +46467,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + prov-status -

ID of Pserver

+

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

 query @@ -44931,56 +46480,139 @@ 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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + - + - + - + - - - - - - - - - - - - - -
- in-maint + hostname +

Value from executing hostname on the compute node.

querypath - boolean + string +
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the physical interface

querypath string +
- prov-status + interface-name -

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

+

Name given to the interface

querypath string +
- interface-id + inv-status -

ID of interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -44992,10 +46624,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + pserver-id -

MAC address for the interface

+

ID of Pserver

 query @@ -45007,14 +46639,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + in-maint -

Name of the network

 query - string + boolean @@ -45022,14 +46653,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + pserver-name2 -

Inner VLAN tag

+

alternative pserver name

 query - integer + string @@ -45037,10 +46668,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + prov-status -

This indicates the customers VPN ID associated with this vlan

+

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

 query @@ -45052,14 +46683,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-id -

Inner VLAN tag

+

ID of interface

 query - integer + string @@ -45067,10 +46698,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + macaddr -

Neutron network id of the interface that address belongs to

+

MAC address for the interface

 query @@ -45082,10 +46713,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + network-name -

Neutron id of subnet that address belongs to

+

Name of the network

 query @@ -45121,7 +46752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l-interface
@@ -45149,17 +46780,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing l-interface
+

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

Tags: CloudInfrastructure
-

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

+

create or update an existing l-interface

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

-

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

+

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

- /l3-interface-ipv4-address-list + /l-interface
@@ -45239,38 +46870,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

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

IP address

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

DELETE /cloud-infrastructure/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 l-interface
+

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

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -45380,54 +46991,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -45459,35 +47022,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/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 l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing l-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -45551,28 +47102,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -45612,24 +47147,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns 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
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -45692,10 +47222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -45708,179 +47238,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + inv-status -

IP address

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery 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 + pserver-id -

Value from executing hostname on the compute node.

+

ID of Pserver

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

- 		queryquery string @@ -45992,36 +47370,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
neutron-network-id @@ -46078,7 +47426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -46106,17 +47454,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /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-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -46125,13 +47473,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -46198,23 +47546,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -46259,23 +47591,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /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-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -46339,23 +47683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -46369,22 +47697,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -46416,35 +47728,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/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 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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -46508,10 +47808,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -46524,12 +47824,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -46569,23 +47869,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -46649,23 +47961,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -46710,35 +48006,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/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
+

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
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -46802,10 +48086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -46847,24 +48131,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
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
-

delete an existing relationship

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
@@ -46927,10 +48206,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -46941,6 +48220,170 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
@@ -46950,6 +48393,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
default @@ -46972,17 +48438,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing l3-interface-ipv6-address-list

@@ -46991,13 +48457,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

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /relationship + /l3-interface-ipv6-address-list
@@ -47046,73 +48512,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- hostname + interface-name -

Value from executing hostname on the compute node.

+

Name given to the interface

 path @@ -47125,10 +48530,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv6-address -

Name that identifies the physical interface

+

IP address

 path @@ -47170,17 +48575,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -47189,13 +48594,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

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -47228,6 +48633,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -47259,17 +48712,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

+
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 relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -47305,132 +48758,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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

- -
-
- - - - - - - - - - - + + + + + + + + + + + + + + @@ -47465,29 +48831,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /virtual-data-center -
-
-
- -
default @@ -47510,17 +48853,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing virtual-data-center
-

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+
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
-

create or update an existing virtual-data-center

+

see node definition for valid relationships

@@ -47529,13 +48872,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

virtual-data-center object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /virtual-data-center + /relationship
@@ -47554,10 +48897,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + +
- vdc-id + interface-name -

Unique ID of the vdc

+

Name that identifies the physical interface

 path @@ -47443,10 +48776,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-name + interface-name -

Name of the virtual data center

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

 query @@ -47454,6 +48819,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vdc-id + hostname -

Unique ID of the vdc

+

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 @@ -47599,17 +48990,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing virtual-data-center
-

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

+
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 virtual-data-center

+

delete an existing relationship

@@ -47631,10 +49022,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + hostname -

Unique ID of the vdc

+

Value from executing hostname on the compute node.

 path @@ -47647,12 +49038,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -47692,11 +49115,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -47711,7 +49134,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

@@ -47736,10 +49159,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + hostname -

Unique ID of the vdc

+

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 @@ -47781,11 +49236,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -47813,10 +49268,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + hostname -

Unique ID of the vdc

+

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 @@ -47858,81 +49345,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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}

+
returns sriov-vfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: - Network + CloudInfrastructure
-

returns generic-vnf

+

returns sriov-vfs

@@ -47949,10 +49372,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -47965,40 +49388,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name that identifies the physical interface

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name given to the interface

querypath string +
- vnf-type + inv-status -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -48010,10 +49435,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + pserver-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

ID of Pserver

 query @@ -48025,14 +49450,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + in-maint -

Regional way of organizing pservers, source of truth should define values

 query - string + boolean @@ -48040,10 +49464,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + pserver-name2 -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

alternative pserver name

 query @@ -48055,10 +49479,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + prov-status -

Heat stack id corresponding to this instance, managed by MSO

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -48070,13 +49494,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + interface-id +

ID of interface

 query - boolean + string @@ -48084,13 +49509,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + macaddr +

MAC address for the interface

 query - boolean + string @@ -48098,10 +49524,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + network-name -

the ASDC model id for this resource or service model.

+

Name of the network

 query @@ -48111,72 +49537,155 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- model-version-id + hostname -

the ASDC model version for this resource or service model.

+

Value from executing hostname on the compute node.

querypath string +
- widget-model-id + interface-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name that identifies the physical interface

querypath string +
- widget-model-version + interface-name -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Name given to the interface

querypath string +
- nf-type + pci-id -

Generic description of the type of NF

+

PCI ID used to identify the sriov-vf

querypath string +
- nf-function + inv-status -

English description of Network function that the specific VNF deployment is providing

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -48188,10 +49697,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + pserver-id -

role in the network that this model will be providing

+

ID of Pserver

 query @@ -48203,20 +49712,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + in-maint -

string assigned to this model used for naming purposes

 query - string + 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 + + +
@@ -48242,7 +49885,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /generic-vnf + /sriov-vf
@@ -48270,17 +49913,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing generic-vnf
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

+
create or update an existing 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: - Network + CloudInfrastructure
-

create or update an existing generic-vnf

+

create or update an existing sriov-vf

@@ -48289,13 +49932,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

generic-vnf object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /generic-vnf + /sriov-vf
@@ -48314,10 +49957,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

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 @@ -48359,23 +50050,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing generic-vnf
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

+
update an existing 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: - Network + CloudInfrastructure
-

delete an existing generic-vnf

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -48391,10 +50094,183 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

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 @@ -48452,19 +50328,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlements
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

+
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: - Network + CloudInfrastructure
-

returns entitlements

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -48479,10 +50372,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -48495,158 +50388,287 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name that identifies the physical interface

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name given to the interface

querypath string +
- vnf-type + pci-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /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 +

+
+
+ + + + + + + + + + + - + - + - + - + + +
- service-id + hostname -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Value from executing hostname on the compute node.

querypath 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 + pci-id -

Heat stack id corresponding to this instance, managed by MSO

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - + - + - + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - + + + + + + +
- in-maint + hostname +

Value from executing hostname on the compute node.

querypath - boolean + string +
- is-closed-loop-disabled + interface-name +

Name that identifies the physical interface

querypath - boolean + string +
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name given to the interface

querypath string +
- model-version-id + inv-status -

the ASDC model version for this resource or service model.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -48658,10 +50680,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + pserver-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

ID of Pserver

 query @@ -48673,10 +50695,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + in-maint -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+ 		query + boolean + + +
+ pserver-name2 + +

alternative pserver name

 query @@ -48688,10 +50724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + prov-status -

Generic description of the type of NF

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -48703,10 +50739,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + interface-id -

English description of Network function that the specific VNF deployment is providing

+

ID of interface

 query @@ -48718,10 +50754,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + macaddr -

role in the network that this model will be providing

+

MAC address for the interface

 query @@ -48733,10 +50769,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + network-name -

string assigned to this model used for naming purposes

+

Name of the network

 query @@ -48772,7 +50808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlements + /vlans
@@ -48800,17 +50836,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlement
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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: - Network + CloudInfrastructure
-

returns entitlement

+

returns vlan

@@ -48827,10 +50863,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -48843,10 +50879,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -48859,10 +50895,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

 path @@ -48875,85 +50911,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

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 + vlan-interface -

Regional way of organizing pservers, source of truth should define values

+

String that identifies the interface

querypath string +
- prov-status + inv-status -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -48965,10 +50942,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + pserver-id -

Heat stack id corresponding to this instance, managed by MSO

+

ID of Pserver

 query @@ -48994,39 +50971,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

- 		query - string - - -
- model-version-id + pserver-name2 -

the ASDC model version for this resource or service model.

+

alternative pserver name

 query @@ -49038,10 +50986,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + prov-status -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -49053,10 +51001,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + interface-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

ID of interface

 query @@ -49068,10 +51016,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + macaddr -

Generic description of the type of NF

+

MAC address for the interface

 query @@ -49083,10 +51031,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + network-name -

English description of Network function that the specific VNF deployment is providing

+

Name of the network

 query @@ -49098,14 +51046,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + vlan-id-inner -

role in the network that this model will be providing

+

Inner VLAN tag

 query - string + integer @@ -49113,10 +51061,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + vpn-id -

string assigned to this model used for naming purposes

+

This indicates the customers VPN ID associated with this vlan

 query @@ -49152,7 +51100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlement + /vlan
@@ -49180,17 +51128,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing entitlement
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
create or update an existing vlan
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: - Network + CloudInfrastructure
-

create or update an existing entitlement

+

create or update an existing vlan

@@ -49199,13 +51147,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /entitlement + /vlan
@@ -49224,10 +51172,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -49240,10 +51188,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -49256,10 +51204,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -49301,23 +51265,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing entitlement
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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: - Network + CloudInfrastructure
-

delete an existing entitlement

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -49333,10 +51309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -49349,10 +51325,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -49365,10 +51341,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

 path @@ -49381,12 +51357,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath string @@ -49426,35 +51402,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+
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: - Network + CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing vlan

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -49470,10 +51434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -49486,10 +51450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -49502,10 +51466,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -49516,6 +51496,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -49547,24 +51543,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+
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: - Network + CloudInfrastructure
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -49579,10 +51570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -49595,10 +51586,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -49611,10 +51602,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

 path @@ -49625,68 +51616,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l-interfaces
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

- Tags: - Network -
-
-
-

returns l-interfaces

- -
-
- - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - -
- vnf-id + vlan-interface -

Unique id of VNF. This is unique across the graph.

+

String that identifies the interface

 path @@ -49699,25 +51634,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + l3-interface-ipv4-address -

Name of VNF.

+

IP address

querypath string +
- vnf-name2 + inv-status -

Alternate name of VNF.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -49729,10 +51665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + pserver-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

ID of Pserver

 query @@ -49744,14 +51680,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + in-maint -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query - string + boolean @@ -49759,10 +51694,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + pserver-name2 -

Regional way of organizing pservers, source of truth should define values

+

alternative pserver name

 query @@ -49789,53 +51724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + interface-id -

the ASDC model id for this resource or service model.

+

ID of interface

 query @@ -49847,10 +51739,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + macaddr -

the ASDC model version for this resource or service model.

+

MAC address for the interface

 query @@ -49862,10 +51754,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + network-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name of the network

 query @@ -49877,14 +51769,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + vlan-id-inner -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Inner VLAN tag

 query - string + integer @@ -49892,10 +51784,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + vpn-id -

Generic description of the type of NF

+

This indicates the customers VPN ID associated with this vlan

 query @@ -49907,14 +51799,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + vlan-id-inner -

English description of Network function that the specific VNF deployment is providing

+

Inner VLAN tag

 query - string + integer @@ -49922,10 +51814,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + neutron-network-id -

role in the network that this model will be providing

+

Neutron network id of the interface that address belongs to

 query @@ -49937,10 +51829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + neutron-subnet-id -

string assigned to this model used for naming purposes

+

Neutron id of subnet that address belongs to

 query @@ -49976,7 +51868,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /l3-interface-ipv4-address-list
@@ -50004,19 +51896,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+
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: - Network + CloudInfrastructure
-

returns l-interface

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -50031,10 +51940,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -50050,7 +51959,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 physical interface

 path @@ -50063,293 +51972,352 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- 		query - string - - -
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

Name given to the interface

querypath string +
- prov-status + vlan-interface -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

String that identifies the interface

querypath string +
- heat-stack-id + l3-interface-ipv4-address -

Heat stack id corresponding to this instance, managed by MSO

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + - + - + + +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + hostname -

the ASDC model id for this resource or service model.

+

Value from executing hostname on the compute node.

querypath string +
- model-version-id + interface-name -

the ASDC model version for this resource or service model.

+

Name that identifies the physical interface

querypath string +
- widget-model-id + interface-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name given to the interface

querypath string +
- widget-model-version + vlan-interface -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

String that identifies the interface

querypath string +
- nf-type + l3-interface-ipv4-address -

Generic description of the type of NF

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/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 +

+
+
+ + + + + + + + + + + - + - + - + - + - + @@ -50368,29 +52337,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -50413,17 +52359,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+
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: - Network + CloudInfrastructure
-

create or update an existing l-interface

+

see node definition for valid relationships

@@ -50432,13 +52378,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

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /l-interface + /relationship
@@ -50457,10 +52403,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
- nf-function + hostname -

English description of Network function that the specific VNF deployment is providing

+

Value from executing hostname on the compute node.

querypath string +
- nf-role + interface-name -

role in the network that this model will be providing

+

Name that identifies the physical interface

querypath string +
- nf-naming-code + interface-name -

string assigned to this model used for naming purposes

+

Name given to the interface

querypath string +
- interface-id + vlan-interface -

ID of interface

+

String that identifies the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

 query @@ -50357,6 +52325,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -50476,7 +52422,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 physical interface

 path @@ -50487,73 +52433,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + interface-name -

Unique id of VNF. This is unique across the graph.

+

Name given to the interface

 path @@ -50566,10 +52451,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -50582,12 +52467,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -50627,19 +52512,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
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: - Network + CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -50654,10 +52544,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -50673,7 +52563,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 physical interface

 path @@ -50686,10 +52576,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 @@ -50702,158 +52592,178 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 + vlan-interface -

Alternate name of VNF.

+

String that identifies the interface

querypath string +
- vnf-type + l3-interface-ipv4-address -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ 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

+ +
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- service-id + hostname -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Value from executing hostname on the compute node.

querypath 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

+

String that identifies the interface

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + l3-interface-ipv6-address -

the ASDC model id for this resource or service model.

+

IP address

querypath string +
- model-version-id + inv-status -

the ASDC model version for this resource or service model.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -50865,10 +52775,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + pserver-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

ID of Pserver

 query @@ -50880,14 +52790,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + in-maint -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query - string + boolean @@ -50895,10 +52804,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + pserver-name2 -

Generic description of the type of NF

+

alternative pserver name

 query @@ -50910,10 +52819,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + prov-status -

English description of Network function that the specific VNF deployment is providing

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -50925,10 +52834,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + interface-id -

role in the network that this model will be providing

+

ID of interface

 query @@ -50940,10 +52849,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + macaddr -

string assigned to this model used for naming purposes

+

MAC address for the interface

 query @@ -50955,10 +52864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-name -

ID of interface

+

Name of the network

 query @@ -50970,14 +52879,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

+

Inner VLAN tag

 query - string + integer @@ -50985,10 +52894,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vpn-id -

Name of the network

+

This indicates the customers VPN ID associated with this vlan

 query @@ -51069,7 +52978,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -51097,17 +53006,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/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-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: - Network + CloudInfrastructure
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing l3-interface-ipv6-address-list

@@ -51116,13 +53025,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

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -51141,10 +53050,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

 path @@ -51173,7 +53098,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address

IP address

@@ -51218,23 +53159,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/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-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: - Network + CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

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 +
+
+
@@ -51250,10 +53203,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + + + + + + + + + + + + + + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

 path @@ -51282,10 +53251,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 @@ -51298,12 +53267,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -51343,35 +53312,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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: - Network + CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -51387,10 +53344,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

 path @@ -51419,7 +53392,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address

IP address

@@ -51433,6 +53422,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -51464,23 +53469,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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: - Network + CloudInfrastructure
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -51496,10 +53513,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -51515,7 +53532,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 physical interface

 path @@ -51528,10 +53545,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 @@ -51542,8 +53559,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -51573,19 +53622,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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: - Network + CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -51600,10 +53654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -51998,29 +53741,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
default @@ -52043,17 +53763,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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: - Network + CloudInfrastructure
-

create or update an existing l3-interface-ipv6-address-list

+

see node definition for valid relationships

@@ -52062,13 +53782,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /l3-interface-ipv6-address-list + /relationship
@@ -52087,10 +53807,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -51619,7 +53673,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 physical interface

 path @@ -51632,10 +53686,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 @@ -51648,345 +53702,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- 		query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

- 		query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

- 		query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- 		query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- 		query - string - - -
- nf-type - -

Generic description of the type of NF

- 		query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

- 		query - string - - -
- nf-role - -

role in the network that this model will be providing

- 		query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

 path @@ -52119,10 +53855,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 @@ -52164,17 +53900,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/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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: - Network + CloudInfrastructure
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing relationship

@@ -52196,10 +53932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -52215,7 +53951,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 physical interface

 path @@ -52228,10 +53964,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 @@ -52244,12 +53980,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath string @@ -52289,13 +54025,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: - Network + CloudInfrastructure
@@ -52308,7 +54044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

@@ -52333,10 +54069,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -52352,23 +54088,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

+

Name that identifies the physical interface

 path @@ -52410,13 +54130,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: - Network + CloudInfrastructure
@@ -52442,10 +54162,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + hostname -

Unique id of VNF. This is unique across the graph.

+

Value from executing hostname on the compute node.

 path @@ -52461,23 +54181,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

+

Name that identifies the physical interface

 path @@ -52519,13 +54223,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

Tags: - Network + CloudInfrastructure
@@ -52538,7 +54242,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)

@@ -52563,26 +54267,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

 path @@ -52624,13 +54312,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

Tags: - Network + CloudInfrastructure
@@ -52656,26 +54344,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

 path @@ -52717,17 +54389,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
returns virtual-data-centers
+

GET /cloud-infrastructure/virtual-data-centers

Tags: - Network + CloudInfrastructure
-

returns sriov-vfs

+

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

@@ -52744,26 +54480,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + vdc-id -

Name given to the interface

+

Unique ID of the vdc

 path @@ -52776,293 +54496,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- 		query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

- 		query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

- 		query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- 		query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- 		query - string - - -
- nf-type - -

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 + vdc-name -

Name of the network

+

Name of the virtual data center

 query @@ -53098,7 +54535,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /virtual-data-center
@@ -53126,19 +54563,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing virtual-data-center
+

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: - Network + CloudInfrastructure
-

returns sriov-vf

+

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/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+
+
+
+ /virtual-data-center +
+
+
+
@@ -53153,26 +54607,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - +
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + vdc-id -

Name given to the interface

+

Unique ID of the vdc

 path @@ -53183,12 +54621,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id +
+
+ +
+

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 -

PCI ID used to identify the sriov-vf

+

Unique ID of the vdc

 path @@ -53199,27 +54710,89 @@ 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 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 +

+
+
+ + + + + + + + + + + - + + +
- vnf-name + vdc-id -

Name of VNF.

+

Unique ID of the vdc

querypath string +
- vnf-name2 + resource-version -

Alternate name of VNF.

+

resource-version for concurrency

 query @@ -53227,59 +54800,317 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/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/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + + +
- vnf-type + vdc-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Unique ID of the vdc

querypath 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 +

+
+
+ + + + + + + + + + + - + + +
- service-id + vdc-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Unique ID of the vdc

querypath 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

+ +
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- regional-resource-zone + vnf-id -

Regional way of organizing pservers, source of truth should define values

+

Unique id of VNF. This is unique across the graph.

querypath string +
- prov-status + vnf-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name of VNF.

 query @@ -53291,10 +55122,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vnf-name2 -

Heat stack id corresponding to this instance, managed by MSO

+

Alternate name of VNF.

 query @@ -53306,38 +55137,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + vnf-type -

the ASDC model id for this resource or service model.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -53349,10 +55152,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + service-id -

the ASDC model version for this resource or service model.

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query @@ -53364,10 +55167,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + regional-resource-zone -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Regional way of organizing pservers, source of truth should define values

 query @@ -53379,10 +55182,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + prov-status -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -53394,10 +55197,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + heat-stack-id -

Generic description of the type of NF

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -53409,14 +55212,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + in-maint -

English description of Network function that the specific VNF deployment is providing

 query - string + boolean @@ -53424,14 +55226,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + is-closed-loop-disabled -

role in the network that this model will be providing

 query - string + boolean @@ -53439,10 +55240,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + model-invariant-id -

string assigned to this model used for naming purposes

+

the ASDC model id for this resource or service model.

 query @@ -53454,10 +55255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + model-version-id -

ID of interface

+

the ASDC model version for this resource or service model.

 query @@ -53469,10 +55270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + widget-model-id -

MAC address for the interface

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -53484,10 +55285,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + widget-model-version -

Name of the network

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -53499,10 +55300,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + nf-type -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Generic description of the type of NF

 query @@ -53514,10 +55315,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + nf-function -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

English description of Network function that the specific VNF deployment is providing

 query @@ -53529,14 +55330,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + nf-role -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

role in the network that this model will be providing

 query - boolean + string @@ -53544,10 +55345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + nf-naming-code -

Neutron network id of the interface

+

string assigned to this model used for naming purposes

 query @@ -53583,7 +55384,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /generic-vnf
@@ -53611,17 +55412,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/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing generic-vnf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

create or update an existing sriov-vf

+

create or update an existing generic-vnf

@@ -53630,13 +55431,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

+

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)

- /sriov-vf + /generic-vnf
@@ -53669,163 +55470,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
-
- -
-

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 - - - -
@@ -53857,17 +55501,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
update an existing generic-vnf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

see node definition for valid relationships

+

update an existing generic-vnf

@@ -53876,13 +55520,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

+

generic-vnf object that needs to be created or updated.

- /relationship + /generic-vnf
@@ -53915,38 +55559,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -53978,17 +55590,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
delete an existing generic-vnf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

delete an existing relationship

+

delete an existing generic-vnf

@@ -54026,28 +55638,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

pathquery string @@ -54087,17 +55683,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

+
returns entitlements
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

Tags: Network
-

returns vlans

+

returns entitlements

@@ -54128,22 +55724,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
vnf-name @@ -54397,51 +55977,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -54468,7 +56003,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /entitlements
@@ -54496,17 +56031,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns entitlement
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

returns vlan

+

returns entitlement

@@ -54539,10 +56074,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -54555,10 +56090,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-uuid -

String that identifies the interface

+

Unique ID of an entitlement resource.

 path @@ -54822,81 +56357,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -54923,7 +56383,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /entitlement
@@ -54951,17 +56411,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vlan
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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 vlan

+

create or update an existing entitlement

@@ -54970,13 +56430,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

- /vlan + /entitlement
@@ -55011,10 +56471,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -55027,10 +56487,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-uuid -

String that identifies the interface

+

Unique ID of an entitlement resource.

 path @@ -55072,23 +56532,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing entitlement
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing vlan

+

update an existing entitlement

application/json application/xml

+
+
+

entitlement object that needs to be created or updated.

+

+
+
+
+
+ /entitlement +
+
+
@@ -55120,10 +56592,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -55136,10 +56608,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-uuid -

String that identifies the interface

+

Unique ID of an entitlement resource.

 path @@ -55150,22 +56622,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -55197,19 +56653,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing entitlement
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

delete an existing entitlement

+
+ +

application/json application/xml +

+
@@ -55240,10 +56701,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -55256,10 +56717,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-uuid -

String that identifies the interface

+

Unique ID of an entitlement resource.

 path @@ -55272,12 +56733,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -55286,134 +56747,318 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/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/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + - + + +
- vnf-name + vnf-id -

Name of VNF.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vnf-name2 + group-uuid -

Alternate name of VNF.

+

Unique ID for the entitlement group the resource comes from, should be uuid.

querypath string +
- vnf-type + resource-uuid -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Unique ID of an entitlement resource.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + + +
- service-id + vnf-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Unique id of VNF. This is unique across the graph.

querypath string +
- regional-resource-zone + group-uuid -

Regional way of organizing pservers, source of truth should define values

+

Unique ID for the entitlement group the resource comes from, should be uuid.

querypath string +
- prov-status + resource-uuid -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique ID of an entitlement resource.

querypath 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

+ +
+
+ + + + + + + + + + + - + - - - - - - -
- heat-stack-id + vnf-id -

Heat stack id corresponding to this instance, managed by MSO

+

Unique id of VNF. This is unique across the graph.

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + vnf-name +

Name of VNF.

 query - boolean + string @@ -55421,10 +57066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + vnf-name2 -

the ASDC model id for this resource or service model.

+

Alternate name of VNF.

 query @@ -55436,10 +57081,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + vnf-type -

the ASDC model version for this resource or service model.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -55451,10 +57096,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + service-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query @@ -55466,10 +57111,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + regional-resource-zone -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Regional way of organizing pservers, source of truth should define values

 query @@ -55481,10 +57126,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + prov-status -

Generic description of the type of NF

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -55496,10 +57141,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + heat-stack-id -

English description of Network function that the specific VNF deployment is providing

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -55511,14 +57156,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + in-maint -

role in the network that this model will be providing

 query - string + boolean @@ -55526,14 +57170,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + is-closed-loop-disabled -

string assigned to this model used for naming purposes

 query - string + boolean @@ -55541,10 +57184,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + model-invariant-id -

ID of interface

+

the ASDC model id for this resource or service model.

 query @@ -55556,10 +57199,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + model-version-id -

MAC address for the interface

+

the ASDC model version for this resource or service model.

 query @@ -55571,10 +57214,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + widget-model-id -

Name of the network

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -55586,14 +57229,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + widget-model-version -

Inner VLAN tag

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query - integer + string @@ -55601,10 +57244,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + nf-type -

This indicates the customers VPN ID associated with this vlan

+

Generic description of the type of NF

 query @@ -55616,14 +57259,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + nf-function -

Inner VLAN tag

+

English description of Network function that the specific VNF deployment is providing

 query - integer + string @@ -55631,10 +57274,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + nf-role -

Neutron network id of the interface that address belongs to

+

role in the network that this model will be providing

 query @@ -55646,10 +57289,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + nf-naming-code -

Neutron id of subnet that address belongs to

+

string assigned to this model used for naming purposes

 query @@ -55685,7 +57328,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l-interfaces
@@ -55713,36 +57356,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns l-interface

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -55789,167 +57415,293 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- vlan-interface + vnf-name -

String that identifies the interface

+

Name of VNF.

pathquery string -
- l3-interface-ipv4-address + vnf-name2 -

IP address

+

Alternate name of VNF.

pathquery 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 -

-
-
- - - - - - - - - - - - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -55969,6 +57720,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
default @@ -55991,17 +57765,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing l-interface

@@ -56010,13 +57784,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

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

- /relationship + /l-interface
@@ -56065,12 +57839,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id + vnf-type -

Unique id of VNF. This is unique across the graph.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery string -
- interface-name + service-id -

Name given to the interface

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

pathquery string -
- vlan-interface + regional-resource-zone -

String that identifies the interface

+

Regional way of organizing pservers, source of truth should define values

pathquery string -
- l3-interface-ipv4-address + prov-status -

IP address

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- resource-version + heat-stack-id -

resource-version for concurrency

+

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 @@ -55957,7 +57709,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -56083,10 +57930,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 @@ -56128,17 +57975,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 l-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

delete an existing l-interface

@@ -56192,28 +58039,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -56253,17 +58084,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -56312,23 +58143,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -56655,36 +58470,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
neutron-network-id @@ -56741,7 +58526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -56769,17 +58554,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -56788,13 +58573,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -56845,23 +58630,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -56906,23 +58675,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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-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
-

delete an existing l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -56970,23 +58751,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -57000,22 +58765,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -57047,35 +58796,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -57123,10 +58860,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -57139,12 +58876,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -57184,23 +58921,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
+

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
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -57248,23 +58997,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -57309,35 +59042,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -57385,10 +59106,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -57430,24 +59151,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
@@ -57494,82 +59210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
-
- -
-

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 + l3-interface-ipv6-address -

Unique id of VNF. This is unique across the graph.

+

IP address

 path @@ -57833,6 +59477,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -57859,7 +59593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /l3-interface-ipv6-address-list
@@ -57887,19 +59621,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns lag-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+
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
-

returns lag-interface

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -57933,7 +59684,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 given to the interface

 path @@ -57946,188 +59697,256 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id + l3-interface-ipv6-address -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/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 +
+
+
+
+
+ + + + + + + + + + + - + - + - + + +
- regional-resource-zone + vnf-id -

Regional way of organizing pservers, source of truth should define values

+

Unique id of VNF. This is unique across the graph.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name given to the interface

querypath string +
- heat-stack-id + l3-interface-ipv6-address -

Heat stack id corresponding to this instance, managed by MSO

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing 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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + + +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + vnf-id -

the ASDC model id for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- model-version-id + interface-name -

the ASDC model version for this resource or service model.

+

Name given to the interface

querypath string +
- widget-model-id + l3-interface-ipv6-address -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

IP address

querypath string +
- widget-model-version + resource-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

resource-version for concurrency

 query @@ -58135,96 +59954,237 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + - + + +
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + l3-interface-ipv6-address -

role in the network that this model will be providing

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +

+
+
+ + + + + + + + + + + - + - + - + @@ -58236,29 +60196,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interface -
-
-
- -
default @@ -58281,17 +60218,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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+
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
-

create or update an existing lag-interface

+

see node definition for valid relationships

@@ -58300,13 +60237,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

- /lag-interface + /relationship
@@ -58344,7 +60281,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - -
- nf-naming-code + vnf-id -

string assigned to this model used for naming purposes

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + l3-interface-ipv6-address -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

IP address

querypath string +
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -58386,17 +60323,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+
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 lag-interface

+

delete an existing relationship

@@ -58437,7 +60374,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 given to the interface

 path @@ -58448,22 +60385,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -58495,17 +60416,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interfaces
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+
returns sriov-vfs
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

returns l-interfaces

+

returns sriov-vfs

@@ -58541,7 +60462,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 given to the interface

 path @@ -58822,10 +60743,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

 query @@ -58861,7 +60797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /sriov-vfs
@@ -58889,17 +60825,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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 l-interface

+

returns sriov-vf

@@ -58935,7 +60871,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 given to the interface

 path @@ -58948,10 +60884,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + pci-id -

Name given to the interface

+

PCI ID used to identify the sriov-vf

 path @@ -59232,10 +61168,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

MAC address for the interface

 query @@ -59247,10 +61183,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-name -

ID of interface

+

Name of the network

 query @@ -59262,10 +61198,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-vlan-filter -

MAC address for the interface

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query @@ -59277,10 +61213,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vf-mac-filter -

Name of the network

+

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 @@ -59316,7 +61282,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /sriov-vf
@@ -59344,17 +61310,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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 l-interface

+

create or update an existing sriov-vf

@@ -59363,13 +61329,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

- /l-interface + /sriov-vf
@@ -59407,7 +61373,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 given to the interface

 path @@ -59420,10 +61386,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + pci-id -

Name given to the interface

+

PCI ID used to identify the sriov-vf

 path @@ -59465,23 +61431,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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
-

delete an existing l-interface

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -59516,7 +61494,100 @@ 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 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 @@ -59543,6 +61614,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
resource-version @@ -59590,19 +61677,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -59636,7 +61740,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 given to the interface

 path @@ -59649,10 +61753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + pci-id -

Name given to the interface

+

PCI ID used to identify the sriov-vf

 path @@ -59663,12 +61767,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/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 +

+
+
+ + + + + + + + + + + - + - + + +
- l3-interface-ipv4-address + vnf-id -

IP address

+

Unique id of VNF. This is unique across the graph.

 path @@ -59681,70 +61846,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + pci-id -

Alternate name of VNF.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

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-type + vnf-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- service-id + interface-name -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Name given to the interface

querypath string +
- regional-resource-zone + vnf-name -

Regional way of organizing pservers, source of truth should define values

+

Name of VNF.

 query @@ -59756,10 +61981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vnf-name2 -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Alternate name of VNF.

 query @@ -59771,10 +61996,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vnf-type -

Heat stack id corresponding to this instance, managed by MSO

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -59786,27 +62011,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + service-id +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query - boolean + string @@ -59814,10 +62026,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + regional-resource-zone -

the ASDC model id for this resource or service model.

+

Regional way of organizing pservers, source of truth should define values

 query @@ -59829,10 +62041,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + prov-status -

the ASDC model version for this resource or service model.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -59844,10 +62056,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + heat-stack-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -59859,14 +62071,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + in-maint -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query - string + boolean @@ -59874,14 +62085,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + is-closed-loop-disabled -

Generic description of the type of NF

 query - string + boolean @@ -59889,10 +62099,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + model-invariant-id -

English description of Network function that the specific VNF deployment is providing

+

the ASDC model id for this resource or service model.

 query @@ -59904,10 +62114,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + model-version-id -

role in the network that this model will be providing

+

the ASDC model version for this resource or service model.

 query @@ -59919,10 +62129,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + widget-model-id -

string assigned to this model used for naming purposes

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -59934,10 +62144,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + widget-model-version -

ID of interface

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -59949,10 +62159,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + nf-type -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Generic description of the type of NF

 query @@ -59964,10 +62174,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + nf-function -

ID of interface

+

English description of Network function that the specific VNF deployment is providing

 query @@ -59979,10 +62189,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + nf-role -

MAC address for the interface

+

role in the network that this model will be providing

 query @@ -59994,10 +62204,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + nf-naming-code -

Name of the network

+

string assigned to this model used for naming purposes

 query @@ -60009,14 +62219,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-id -

Inner VLAN tag

+

ID of interface

 query - integer + string @@ -60024,10 +62234,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + macaddr -

Neutron network id of the interface that address belongs to

+

MAC address for the interface

 query @@ -60039,10 +62249,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + network-name -

Neutron id of subnet that address belongs to

+

Name of the network

 query @@ -60078,7 +62288,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vlans
@@ -60106,36 +62316,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns vlan
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns vlan

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -60169,7 +62362,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -60221,6 +62726,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -60243,23 +62771,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/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 vlan
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -60182,10 +62375,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -60198,18 +62391,330 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vnf-name -

IP address

+

Name of VNF.

pathquery + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+ 		query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+ 		query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+ 		query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+ 		query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+ 		query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+ 		query + string + + +
+ nf-type + +

Generic description of the type of NF

+ 		query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+ 		query + string + + +
+ nf-role + +

role in the network that this model will be providing

+ 		query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query string -
@@ -60289,22 +62829,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
interface-name @@ -60323,10 +62847,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 @@ -60337,22 +62861,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -60384,17 +62892,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing vlan
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

see node definition for valid relationships

+

update an existing vlan

@@ -60403,13 +62911,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

+

vlan object that needs to be created or updated.

- /relationship + /vlan
@@ -60442,22 +62950,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
interface-name @@ -60476,10 +62968,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 @@ -60521,17 +63013,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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 relationship

+

delete an existing vlan

@@ -60572,7 +63064,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 given to the interface

 path @@ -60585,10 +63077,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -60601,12 +63093,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -60646,17 +63138,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -60692,7 +63184,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 given to the interface

 path @@ -60705,10 +63197,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -60721,7 +63213,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -61005,10 +63497,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

MAC address for the interface

 query @@ -61020,10 +63512,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-name -

ID of interface

+

Name of the network

 query @@ -61035,14 +63527,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

+

Inner VLAN tag

 query - string + integer @@ -61050,10 +63542,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vpn-id -

Name of the network

+

This indicates the customers VPN ID associated with this vlan

 query @@ -61134,7 +63626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -61162,17 +63654,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -61181,13 +63673,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -61225,7 +63717,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 given to the interface

 path @@ -61238,10 +63730,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -61254,7 +63746,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -61299,23 +63791,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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-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
-

delete an existing l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -61350,7 +63854,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 given to the interface

 path @@ -61363,10 +63867,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -61379,7 +63883,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -61393,22 +63897,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -61440,35 +63928,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -61503,7 +63979,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 given to the interface

 path @@ -61516,10 +63992,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -61532,7 +64008,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -61546,6 +64022,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -61577,23 +64069,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -61628,7 +64132,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 given to the interface

 path @@ -61641,10 +64145,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -61657,7 +64161,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -61702,35 +64206,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -61760,22 +64252,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
interface-name @@ -61792,89 +64268,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 + vlan-interface -

Name that identifies the link aggregate interface

+

String that identifies the interface

 path @@ -61887,10 +64286,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -61932,17 +64331,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 sriov-vfs

+

returns l3-interface-ipv6-address-list

@@ -61978,7 +64377,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 given to the interface

 path @@ -61991,10 +64390,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -62275,10 +64690,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

MAC address for the interface

 query @@ -62290,10 +64705,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-name -

ID of interface

+

Name of the network

 query @@ -62305,10 +64720,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

+

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

 query @@ -62320,10 +64750,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vlan-id-inner -

Name of the network

+

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 @@ -62359,7 +64819,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l3-interface-ipv6-address-list
@@ -62387,19 +64847,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -62433,7 +64910,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 given to the interface

 path @@ -62446,10 +64923,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -62462,10 +64939,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -62476,385 +64953,274 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/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-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- 		query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

- 		query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

- 		query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- 		query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- 		query - string - - -
- nf-type - -

Generic description of the type of NF

- 		query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

- 		query - string - - -
- nf-role - -

role in the network that this model will be providing

- 		query - string - - -
- nf-naming-code + vnf-id -

string assigned to this model used for naming purposes

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + vlan-interface -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

String that identifies the interface

querypath string +
- interface-id + l3-interface-ipv6-address -

ID of interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 +

+
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - @@ -62873,29 +65240,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -62918,17 +65262,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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /network/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
-

create or update an existing sriov-vf

+

see node definition for valid relationships

@@ -62937,13 +65281,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /sriov-vf + /relationship
@@ -62981,7 +65325,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- macaddr + vnf-id -

MAC address for the interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vf-vlan-filter + vlan-interface -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

String that identifies the interface

querypath string +
- vf-mac-filter + l3-interface-ipv6-address -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

IP address

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

- 		query - boolean - - -
- neutron-network-id + resource-version -

Neutron network id of the interface

+

resource-version for concurrency

 query @@ -62862,6 +65228,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -62994,10 +65338,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -63010,10 +65354,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -63055,17 +65399,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

delete an existing relationship

@@ -63101,22 +65445,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
interface-name @@ -63135,10 +65463,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -63151,12 +65479,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -63196,11 +65524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -63215,7 +65543,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

@@ -63254,22 +65582,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
interface-name @@ -63288,10 +65600,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -63333,11 +65645,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -63379,22 +65691,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
interface-name @@ -63413,10 +65709,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -63458,17 +65754,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns lag-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

Tags: Network
-

returns vlans

+

returns lag-interfaces

@@ -63499,38 +65795,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
vnf-name @@ -63784,81 +66048,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -63885,7 +66074,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /lag-interfaces
@@ -63913,17 +66102,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns lag-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

returns vlan

+

returns lag-interface

@@ -63970,38 +66159,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
vnf-name @@ -64285,81 +66442,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -64386,7 +66468,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /lag-interface
@@ -64414,17 +66496,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 vlan

+

create or update an existing lag-interface

@@ -64433,13 +66515,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

- /vlan + /lag-interface
@@ -64488,38 +66570,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -64551,23 +66601,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing lag-interface
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing vlan

+

update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+
+ /lag-interface +
+
+
@@ -64613,12 +66675,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing 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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + +
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -64631,10 +66754,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 that identifies the link aggregate interface

 path @@ -64692,17 +66815,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns l-interfaces

@@ -64749,54 +66872,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
vnf-name @@ -65080,12 +67155,139 @@ 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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- interface-id + vnf-id -

ID of interface

+

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 @@ -65097,10 +67299,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vnf-name2 -

MAC address for the interface

+

Alternate name of VNF.

 query @@ -65112,10 +67314,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vnf-type -

Name of the network

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -65127,14 +67329,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + service-id -

Inner VLAN tag

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query - integer + string @@ -65142,10 +67344,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + regional-resource-zone -

This indicates the customers VPN ID associated with this vlan

+

Regional way of organizing pservers, source of truth should define values

 query @@ -65157,14 +67359,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + prov-status -

Inner VLAN tag

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query - integer + string @@ -65172,10 +67374,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + heat-stack-id -

Neutron network id of the interface that address belongs to

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -65187,10 +67389,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + in-maint -

Neutron id of subnet that address belongs to

+ 		query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

 query @@ -65200,180 +67430,184 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
-
- - - - - - - - - - - - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -65385,6 +67619,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
default @@ -65407,23 +67664,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/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 l-interface
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
- vnf-id + model-version-id -

Unique id of VNF. This is unique across the graph.

+

the ASDC model version for this resource or service model.

pathquery string -
- interface-name + widget-model-id -

Name that identifies the link aggregate interface

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

pathquery string -
- interface-name + widget-model-version -

Name given to the interface

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

pathquery string -
- vlan-interface + nf-type -

String that identifies the interface

+

Generic description of the type of NF

pathquery string -
- l3-interface-ipv4-address + nf-function -

IP address

+

English description of Network function that the specific VNF deployment is providing

pathquery + 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 -
@@ -65485,54 +67754,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -65564,17 +67785,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing l-interface

@@ -65583,13 +67804,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

+

l-interface object that needs to be created or updated.

- /relationship + /l-interface
@@ -65654,38 +67875,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -65717,17 +67906,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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 relationship

+

delete an existing l-interface

@@ -65797,28 +67986,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -65858,17 +68031,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -65933,23 +68106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -66306,36 +68463,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
neutron-network-id @@ -66392,7 +68519,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -66420,17 +68547,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -66439,13 +68566,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -66512,164 +68639,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

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 + l3-interface-ipv4-address

IP address

@@ -66683,22 +68653,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -66730,17 +68684,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -66749,13 +68703,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

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -66822,23 +68776,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -66883,17 +68821,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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 relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -66963,10 +68901,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -66979,12 +68917,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -67024,11 +68962,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -67043,7 +68981,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -67116,10 +69054,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -67161,11 +69099,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -67241,10 +69179,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -67286,36 +69224,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -67360,89 +69281,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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

+

Name given to the interface

 path @@ -67453,68 +69297,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns licenses
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

- Tags: - Network -
-
-
-

returns licenses

- -
-
- - - - - - - - - - - - -
- vnf-id + l3-interface-ipv6-address -

Unique id of VNF. This is unique across the graph.

+

IP address

 path @@ -67778,184 +69566,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

ID of interface

 query @@ -67967,10 +69583,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + interface-role -

Regional way of organizing pservers, source of truth should define values

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -67982,10 +69598,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of interface

 query @@ -67997,10 +69613,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + macaddr -

Heat stack id corresponding to this instance, managed by MSO

+

MAC address for the interface

 query @@ -68012,38 +69628,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + network-name -

the ASDC model id for this resource or service model.

+

Name of the network

 query @@ -68055,14 +69643,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + vlan-id-inner -

the ASDC model version for this resource or service model.

+

Inner VLAN tag

 query - string + integer @@ -68070,10 +69658,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + neutron-network-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Neutron network id of the interface that address belongs to

 query @@ -68085,10 +69673,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + neutron-subnet-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Neutron id of subnet that address belongs to

 query @@ -68098,64 +69686,164 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + @@ -68167,29 +69855,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /license -
-
-
- -
default @@ -68212,17 +69877,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing license
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
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
-

create or update an existing license

+

update an existing l3-interface-ipv6-address-list

@@ -68231,13 +69896,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /license + /l3-interface-ipv6-address-list
@@ -68272,10 +69937,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name that identifies the link aggregate interface

querypath string +
- nf-role + interface-name -

role in the network that this model will be providing

+

Name given to the interface

querypath string +
- nf-naming-code + l3-interface-ipv6-address -

string assigned to this model used for naming purposes

+

IP address

querypath string +
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

 path @@ -68288,10 +69953,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -68333,17 +70014,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing license
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
delete an existing l3-interface-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 license

+

delete an existing l3-interface-ipv6-address-list

@@ -68381,10 +70062,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

 path @@ -68397,10 +70078,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -68458,11 +70155,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -68477,7 +70174,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -68518,10 +70215,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

 path @@ -68534,10 +70231,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -68579,11 +70292,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -68627,10 +70340,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the link aggregate interface

 path @@ -68643,10 +70356,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -68688,11 +70417,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

+

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
@@ -68707,7 +70436,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -68746,6 +70475,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
@@ -68777,11 +70538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/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
@@ -68823,6 +70584,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
@@ -68854,17 +70647,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vf-modules
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

+
returns 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 vf-modules

+

returns sriov-vfs

@@ -68895,6 +70688,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
vnf-name @@ -69148,6 +70973,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -69174,7 +71074,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vf-modules + /sriov-vfs
@@ -69202,17 +71102,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vf-module
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
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 vf-module

+

returns sriov-vf

@@ -69245,10 +71145,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -69514,10 +71446,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-name + interface-id -

Name of vf-module

+

ID of interface

 query @@ -69529,10 +71461,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + interface-role -

Heat stack id corresponding to this instance.

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -69544,10 +71476,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + interface-id -

the ASDC model id for this resource or service model.

+

ID of interface

 query @@ -69559,10 +71491,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + macaddr -

the ASDC model version for this resource or service model.

+

MAC address for the interface

 query @@ -69574,10 +71506,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + network-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name of the network

 query @@ -69589,10 +71521,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + vf-vlan-filter -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query @@ -69604,10 +71536,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-service-instance-fqdn + vf-mac-filter -

the Contrail unique ID for a service-instance

+

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 @@ -69643,7 +71605,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vf-module + /sriov-vf
@@ -69671,17 +71633,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vf-module
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
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 vf-module

+

create or update an existing sriov-vf

@@ -69690,13 +71652,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vf-module object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /vf-module + /sriov-vf
@@ -69731,10 +71693,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -69776,23 +71770,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vf-module
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
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
-

delete an existing vf-module

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -69824,10 +71830,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

 path @@ -69840,12 +71846,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path string @@ -69885,35 +71907,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing sriov-vf

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -69945,10 +71955,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vf-module-id + interface-name -

Unique ID of vf-module.

+

Name that identifies the link aggregate interface

 path @@ -69959,73 +71969,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - + + + + + + +
- vnf-id + interface-name -

Unique id of VNF. This is unique across the graph.

+

Name given to the interface

 path @@ -70038,10 +71987,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + pci-id -

Unique ID of vf-module.

+

PCI ID used to identify the sriov-vf

 path @@ -70052,6 +72001,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -70083,83 +72048,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns instance-groups
-

GET /network/instance-groups

+
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
-

returns instance-groups

+

see node definition for valid relationships

- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /instance-groups -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

- -
-
-
-
-
- - -
-
-
returns instance-group
-

GET /network/instance-groups/instance-group/{id}

- Tags: - Network -
-
-
-

returns instance-group

- -
+
+
+
+ /relationship +
+
+
+
@@ -70174,10 +72092,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -70242,29 +72163,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /instance-group -
-
-
- -
default @@ -70287,35 +72185,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing instance-group
-

PUT /network/instance-groups/instance-group/{id}

+
delete an existing 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
-

create or update an existing instance-group

+

delete an existing relationship

application/json application/xml

-
-
-

instance-group object that needs to be created or updated

-

-
-
-
-
- /instance-group -
-
-
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

 path @@ -70190,47 +72108,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- description + interface-name -

Descriptive text to help identify the usage of this instance-group

+

Name that identifies the link aggregate interface

querypath string +
- type + interface-name -

Only valid value today is lower case ha for high availability

+

Name given to the interface

querypath string +
- sub-type + pci-id -

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -70331,10 +72217,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

 path @@ -70345,73 +72231,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing instance-group
-

DELETE /network/instance-groups/instance-group/{id}

- Tags: - Network -
-
-
-

delete an existing instance-group

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - -
- id + interface-name -

Instance Group ID, UUID assigned to this instance.

+

Name that identifies the link aggregate interface

 path @@ -70424,12 +72249,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath string @@ -70438,85 +72263,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - -
- id + pci-id -

Instance Group ID, UUID assigned to this instance.

+

PCI ID used to identify the sriov-vf

 path @@ -70558,24 +72310,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

+
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
-

delete an existing relationship

+

returns vlans

-
- -

application/json application/xml -

-
@@ -70590,10 +72337,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- id + vnf-id -

Instance Group ID, UUID assigned to this instance.

+

Unique id of VNF. This is unique across the graph.

 path @@ -70604,132 +72351,28 @@ 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 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 + interface-name -

UUID of this configuration

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -70740,6 +72383,334 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vnf-name + +

Name of VNF.

+ 		query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+ 		query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+ 		query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+ 		query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+ 		query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+ 		query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+ 		query + string + + +
+ nf-type + +

Generic description of the type of NF

+ 		query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+ 		query + string + + +
+ nf-role + +

role in the network that this model will be providing

+ 		query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
@@ -70766,7 +72737,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ipsec-configuration + /vlans
@@ -70794,36 +72765,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing ipsec-configuration
-

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+
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
-

create or update an existing ipsec-configuration

+

returns vlan

-
- -

application/json application/xml -

-
-
-

ipsec-configuration object that needs to be created or updated

-

-
-
-
-
- /ipsec-configuration -
-
-
-
@@ -70838,10 +72792,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- ipsec-configuration-id + vnf-id -

UUID of this configuration

+

Unique id of VNF. This is unique across the graph.

 path @@ -70852,73 +72806,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + interface-name -

UUID of this configuration

+

Name that identifies the link aggregate interface

 path @@ -70931,12 +72824,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath string @@ -70945,85 +72838,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - -
- ipsec-configuration-id + vlan-interface -

UUID of this configuration

+

String that identifies the interface

 path @@ -71034,843 +72854,220 @@ 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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - -
- ipsec-configuration-id + vnf-name -

UUID of this configuration

+

Name of VNF.

pathquery 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 + vnf-name2 -

UUID of this configuration

+

Alternate name of VNF.

pathquery 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 + vnf-type -

UUID of this configuration

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery string -
- vig-address-type + service-id -

indicates whether the VIG is for AVPN or INTERNET

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

pathquery 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

-

-
-
-
-
- /vig-server -
-
-
-
-
- - - - - - - - - - - - + - + - -
- ipsec-configuration-id + regional-resource-zone -

UUID of this configuration

+

Regional way of organizing pservers, source of truth should define values

pathquery string -
- vig-address-type + prov-status -

indicates whether the VIG is for AVPN or INTERNET

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery 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 + heat-stack-id -

UUID of this configuration

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- vig-address-type + in-maint -

indicates whether the VIG is for AVPN or INTERNET

pathquery - string + boolean -
- resource-version + is-closed-loop-disabled -

resource-version for concurrency

 query - string + boolean -
-
- -
-

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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - + - + - -
- ipsec-configuration-id + model-invariant-id -

UUID of this configuration

+

the ASDC model id for this resource or service model.

pathquery string -
- vig-address-type + model-version-id -

indicates whether the VIG is for AVPN or INTERNET

+

the ASDC model version for this resource or service model.

pathquery 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 + widget-model-id -

UUID of this configuration

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

pathquery string -
- vig-address-type + widget-model-version -

indicates whether the VIG is for AVPN or INTERNET

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

pathquery 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 + nf-type -

Network ID, should be uuid. Unique across A&AI.

+

Generic description of the type of NF

pathquery string -
- network-name + nf-function -

Name of the network, governed by some naming convention..

+

English description of Network function that the specific VNF deployment is providing

 query @@ -71882,10 +73079,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-role + nf-role -

Role the network plans - who defines these values?

+

role in the network that this model will be providing

 query @@ -71897,10 +73094,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + nf-naming-code -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

string assigned to this model used for naming purposes

 query @@ -71912,10 +73109,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + interface-id -

Heat stack id corresponding to this instance, managed by MSO

+

ID of interface

 query @@ -71927,10 +73124,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-network-fqdn + interface-role -

Contrail FQDN for the network

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -71942,10 +73139,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + interface-id -

the ASDC model id for this resource or service model.

+

ID of interface

 query @@ -71957,10 +73154,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + macaddr -

the ASDC model version for this resource or service model.

+

MAC address for the interface

 query @@ -71972,10 +73169,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + network-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name of the network

 query @@ -71987,10 +73184,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + vlan-id-inner -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

 query @@ -72026,7 +73238,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-network + /vlan
@@ -72054,17 +73266,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-network
-

PUT /network/l3-networks/l3-network/{network-id}

+
create or update an existing 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 l3-network

+

create or update an existing vlan

@@ -72073,13 +73285,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-network object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

- /l3-network + /vlan
@@ -72098,10 +73310,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

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 @@ -72143,23 +73403,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-network
-

DELETE /network/l3-networks/l3-network/{network-id}

+
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
-

delete an existing l3-network

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -72175,10 +73447,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + - -
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -72191,12 +73463,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string @@ -72236,19 +73540,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-assignments
-

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

+
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
-

returns ctag-assignments

+

delete an existing vlan

+
+ +

application/json application/xml +

+
@@ -72263,10 +73572,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - - - - - - - - - - - - @@ -72421,29 +73659,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-assignments -
-
-
- -
default @@ -72466,17 +73681,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-assignment
-

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
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 ctag-assignment

+

returns l3-interface-ipv4-address-list

@@ -72493,10 +73708,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -72279,130 +73588,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

- 		query - string - - -
- network-role - -

Role the network plans - who defines these values?

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

- 		query - string - - -
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name that identifies the link aggregate interface

querypath string +
- contrail-network-fqdn + interface-name -

Contrail FQDN for the network

+

Name given to the interface

querypath string +
- model-invariant-id + vlan-interface -

the ASDC model id for this resource or service model.

+

String that identifies the interface

querypath string +
- model-version-id + resource-version -

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.

+

resource-version for concurrency

 query @@ -72410,6 +73647,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -72509,14 +73724,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-name -

id.

+

Name that identifies the link aggregate interface

 path - integer + string @@ -72525,10 +73740,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-name -

Name of the network, governed by some naming convention..

+

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 @@ -72540,10 +73803,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-role + vnf-name2 -

Role the network plans - who defines these values?

+

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 @@ -72558,7 +73836,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

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 @@ -72585,14 +73893,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-network-fqdn + in-maint -

Contrail FQDN for the network

 query - string + boolean + + +
+ is-closed-loop-disabled + + query + boolean @@ -72658,6 +73979,216 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ nf-type + +

Generic description of the type of NF

+ 		query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+ 		query + string + + +
+ nf-role + +

role in the network that this model will be providing

+ 		query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ 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 + + +
@@ -72684,7 +74215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ctag-assignment + /l3-interface-ipv4-address-list
@@ -72712,17 +74243,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing ctag-assignment
-

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
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 ctag-assignment

+

create or update an existing l3-interface-ipv4-address-list

@@ -72731,13 +74262,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ctag-assignment object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /ctag-assignment + /l3-interface-ipv4-address-list
@@ -72756,10 +74287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -72772,87 +74303,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-name -

id.

+

Name that identifies the link aggregate interface

 path - integer + string
-
- -
-

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 + interface-name -

Network ID, should be uuid. Unique across A&AI.

+

Name given to the interface

 path @@ -72865,14 +74335,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vlan-interface -

id.

+

String that identifies the interface

 path - integer + string @@ -72881,12 +74351,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -72926,17 +74396,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+
update an existing 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
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -72945,13 +74415,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

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -72970,10 +74440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -72986,14 +74456,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-name -

id.

+

Name that identifies the link aggregate interface

 path - integer + 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 @@ -73031,17 +74549,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+
delete an existing 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 relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -73063,10 +74581,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -73079,14 +74597,78 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-name -

id.

+

Name that identifies the link aggregate interface

 path - integer + 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 @@ -73124,11 +74706,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+

PUT /network/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
@@ -73143,7 +74725,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -73168,10 +74750,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

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 @@ -73213,11 +74859,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+

DELETE /network/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
@@ -73245,10 +74891,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

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 @@ -73290,17 +75000,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns segmentation-assignments
-

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

+
returns l3-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 segmentation-assignments

+

returns l3-interface-ipv6-address-list

@@ -73317,10 +75027,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -73333,70 +75043,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-name -

Name of the network, governed by some naming convention..

+

Name that identifies the link aggregate interface

querypath string +
- network-role + interface-name -

Role the network plans - who defines these values?

+

Name given to the interface

querypath string +
- service-id + vlan-interface -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

String that identifies the interface

querypath string +
- heat-stack-id + l3-interface-ipv6-address -

Heat stack id corresponding to this instance, managed by MSO

+

IP address

querypath string +
- contrail-network-fqdn + vnf-name -

Contrail FQDN for the network

+

Name of VNF.

 query @@ -73408,10 +75122,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + vnf-name2 -

the ASDC model id for this resource or service model.

+

Alternate name of VNF.

 query @@ -73423,10 +75137,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + vnf-type -

the ASDC model version for this resource or service model.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -73438,10 +75152,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + service-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query @@ -73453,10 +75167,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + regional-resource-zone -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Regional way of organizing pservers, source of truth should define values

 query @@ -73466,123 +75180,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + prov-status -

Network ID, should be uuid. Unique across A&AI.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- segmentation-id + heat-stack-id -

Route Table Reference id, UUID assigned to this instance.

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- network-name + in-maint -

Name of the network, governed by some naming convention..

+ 		query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

 query @@ -73594,10 +75255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-role + model-version-id -

Role the network plans - who defines these values?

+

the ASDC model version for this resource or service model.

 query @@ -73609,10 +75270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + widget-model-id -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -73624,10 +75285,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + widget-model-version -

Heat stack id corresponding to this instance, managed by MSO

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -73639,10 +75300,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-network-fqdn + nf-type -

Contrail FQDN for the network

+

Generic description of the type of NF

 query @@ -73654,10 +75315,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + nf-function -

the ASDC model id for this resource or service model.

+

English description of Network function that the specific VNF deployment is providing

 query @@ -73669,10 +75330,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + nf-role -

the ASDC model version for this resource or service model.

+

role in the network that this model will be providing

 query @@ -73684,10 +75345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + nf-naming-code -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

string assigned to this model used for naming purposes

 query @@ -73699,10 +75360,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + interface-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

ID of interface

 query @@ -73712,18 +75373,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- 200 OK - +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ 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 +
@@ -73738,7 +75534,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /segmentation-assignment + /l3-interface-ipv6-address-list
@@ -73766,17 +75562,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing segmentation-assignment
-

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
create or update an existing l3-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 segmentation-assignment

+

create or update an existing l3-interface-ipv6-address-list

@@ -73785,13 +75581,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

segmentation-assignment object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /segmentation-assignment + /l3-interface-ipv6-address-list
@@ -73810,10 +75606,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -73826,10 +75622,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name that identifies the link aggregate interface

 path @@ -73840,73 +75636,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + interface-name -

Network ID, should be uuid. Unique across A&AI.

+

Name given to the interface

 path @@ -73919,10 +75654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + vlan-interface -

Route Table Reference id, UUID assigned to this instance.

+

String that identifies the interface

 path @@ -73935,12 +75670,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -73980,17 +75715,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -73999,13 +75734,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

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -74024,10 +75759,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -74040,10 +75775,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name that identifies the link aggregate interface

 path @@ -74054,73 +75789,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/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 + interface-name -

Network ID, should be uuid. Unique across A&AI.

+

Name given to the interface

 path @@ -74133,10 +75807,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + vlan-interface -

Route Table Reference id, UUID assigned to this instance.

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -74178,19 +75868,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns subnets
-

GET /network/l3-networks/l3-network/{network-id}/subnets

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns subnets

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -74205,10 +75900,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + @@ -74363,29 +76003,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /subnets -
-
-
- -
default @@ -74408,19 +76025,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns subnet
-

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
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
-

returns subnet

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -74221,130 +75916,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

- 		query - string - - -
- network-role - -

Role the network plans - who defines these values?

- 		query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- contrail-network-fqdn + interface-name -

Contrail FQDN for the network

+

Name that identifies the link aggregate interface

querypath string +
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name given to the interface

querypath string +
- model-version-id + vlan-interface -

the ASDC model version for this resource or service model.

+

String that identifies the interface

querypath string +
- widget-model-id + l3-interface-ipv6-address -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

IP address

querypath string +
- widget-model-version + resource-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

resource-version for concurrency

 query @@ -74352,6 +75991,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -74435,10 +76069,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + - + - + + +
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -74451,10 +76085,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name that identifies the link aggregate interface

 path @@ -74467,152 +76101,191 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

- 		query - string - - -
- network-role - -

Role the network plans - who defines these values?

- 		query - string - - -
- service-id + interface-name -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

Name given to the interface

querypath string +
- heat-stack-id + vlan-interface -

Heat stack id corresponding to this instance, managed by MSO

+

String that identifies the interface

querypath string +
- contrail-network-fqdn + l3-interface-ipv6-address -

Contrail FQDN for the network

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + @@ -74624,29 +76297,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /subnet -
-
-
- -
default @@ -74669,17 +76319,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing subnet
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
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
-

create or update an existing subnet

+

see node definition for valid relationships

@@ -74688,13 +76338,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

subnet object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

- /subnet + /relationship
@@ -74713,10 +76363,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + - + + + + + + + + - -
- model-invariant-id + vnf-id -

the ASDC model id for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- model-version-id + interface-name -

the ASDC model version for this resource or service model.

+

Name that identifies the link aggregate interface

querypath string +
- widget-model-id + interface-name -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Name given to the interface

querypath string +
- widget-model-version + vlan-interface -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

String that identifies the interface

querypath string +
- subnet-name + l3-interface-ipv6-address -

Name associated with the subnet.

+

IP address

querypath string +
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -74729,10 +76379,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

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 @@ -74774,17 +76456,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing subnet
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
delete an existing relationship
+

DELETE /network/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 subnet

+

delete an existing relationship

@@ -74806,10 +76488,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -74822,10 +76504,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name that identifies the link aggregate interface

 path @@ -74838,12 +76520,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string @@ -74883,11 +76581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -74902,7 +76600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

@@ -74927,10 +76625,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -74943,10 +76641,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name that identifies the link aggregate interface

 path @@ -74988,11 +76686,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -75020,10 +76718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF. This is unique across the graph.

 path @@ -75036,10 +76734,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name that identifies the link aggregate interface

 path @@ -75081,81 +76779,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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}

+
returns licenses
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

Tags: Network
-

returns lag-link

+

returns licenses

@@ -75172,10 +76806,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id -

Alphabetical concatenation of lag-interface names

+

Unique id of VNF. This is unique across the graph.

 path @@ -75186,201 +76820,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

-

-
-
-
-
- /lag-link -
-
-
-
-
- - - - - - - - - - - - + - -
- link-name + vnf-name -

Alphabetical concatenation of lag-interface names

+

Name of VNF.

pathquery 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 + vnf-name2 -

Alphabetical concatenation of lag-interface names

+

Alternate name of VNF.

pathquery string -
- resource-version + vnf-type -

resource-version for concurrency

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -75388,220 +76863,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - + - -
- link-name + service-id -

Alphabetical concatenation of lag-interface names

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

pathquery 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 + regional-resource-zone -

Alphabetical concatenation of lag-interface names

+

Regional way of organizing pservers, source of truth should define values

pathquery + 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns logical-links
-

GET /network/logical-links

- Tags: - Network -
-
-
-

returns logical-links

- -
-

application/json application/xml

@@ -75624,7 +77099,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /logical-links + /licenses
@@ -75652,17 +77127,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns logical-link
-

GET /network/logical-links/logical-link/{link-name}

+
returns license
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

returns logical-link

+

returns license

@@ -75679,10 +77154,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

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 @@ -75693,6 +77200,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vnf-name + +

Name of VNF.

+ 		query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+ 		query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+ 		query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
model-invariant-id @@ -75755,10 +77395,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + nf-type -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Generic description of the type of NF

 query @@ -75770,10 +77410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-id + nf-function -

UUID of the logical-link, SDNC generates this.

+

English description of Network function that the specific VNF deployment is providing

 query @@ -75785,10 +77425,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- circuit-id + nf-role -

Circuit id

+

role in the network that this model will be providing

 query @@ -75800,10 +77440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- purpose + nf-naming-code -

Reason for this entity, role it is playing

+

string assigned to this model used for naming purposes

 query @@ -75839,7 +77479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /logical-link + /license
@@ -75867,17 +77507,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing logical-link
-

PUT /network/logical-links/logical-link/{link-name}

+
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 logical-link

+

create or update an existing license

@@ -75886,13 +77526,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

logical-link object that needs to be created or updated

+

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)

- /logical-link + /license
@@ -75911,10 +77551,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Unique id of VNF. This is unique across the graph.

 path @@ -75925,73 +77565,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing logical-link
-

DELETE /network/logical-links/logical-link/{link-name}

- Tags: - Network -
-
-
-

delete an existing logical-link

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + - -
- link-name + group-uuid -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -76004,12 +77583,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + resource-uuid -

resource-version for concurrency

+

Unique ID of a license resource.

querypath string @@ -76049,17 +77628,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

+
update an existing license
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

see node definition for valid relationships

+

update an existing license

@@ -76068,13 +77647,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

+

license object that needs to be created or updated.

- /relationship + /license
@@ -76093,10 +77672,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

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 @@ -76138,17 +77749,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

+
delete an existing license
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing relationship

+

delete an existing license

@@ -76170,10 +77781,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Unique id of VNF. This is unique across the graph.

 path @@ -76184,132 +77795,28 @@ 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 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 + group-uuid -

Unique id of multicast configuration.

+

Unique ID for the license group the resource belongs to, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

 path @@ -76320,6 +77827,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -76329,29 +77852,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /multicast-configuration -
-
-
- -
default @@ -76374,17 +77874,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing multicast-configuration
-

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

create or update an existing multicast-configuration

+

see node definition for valid relationships

@@ -76393,13 +77893,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

multicast-configuration object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)

- /multicast-configuration + /relationship
@@ -76418,10 +77918,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id -

Unique id of multicast configuration.

+

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 @@ -76463,17 +77995,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing multicast-configuration
-

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

delete an existing multicast-configuration

+

delete an existing relationship

@@ -76495,10 +78027,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id -

Unique id of multicast configuration.

+

Unique id of VNF. This is unique across the graph.

 path @@ -76511,12 +78043,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + group-uuid -

resource-version for concurrency

+

Unique ID for the license group the resource belongs to, should be uuid.

querypath + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+ 		path string @@ -76556,11 +78104,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network
@@ -76575,7 +78123,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)

@@ -76600,10 +78148,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id -

Unique id of multicast configuration.

+

Unique id of VNF. This is unique across the graph.

 path @@ -76645,11 +78193,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network
@@ -76677,10 +78225,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id -

Unique id of multicast configuration.

+

Unique id of VNF. This is unique across the graph.

 path @@ -76722,21 +78270,305 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns network-policies
-

GET /network/network-policies

+
returns vf-modules
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

Tags: Network
-

returns network-policies

+

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

@@ -76758,7 +78590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-policies + /vf-modules
@@ -76786,17 +78618,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns network-policy
-

GET /network/network-policies/network-policy/{network-policy-id}

+
returns vf-module
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

returns network-policy

+

returns vf-module

@@ -76813,10 +78645,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + vnf-id -

UUID representing unique key to this instance

+

Unique id of VNF. This is unique across the graph.

 path @@ -76829,10 +78661,369 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-fqdn + vf-module-id -

Contrail FQDN for the policy

+

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 @@ -76868,7 +79059,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-policy + /vf-module
@@ -76896,17 +79087,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing network-policy
-

PUT /network/network-policies/network-policy/{network-policy-id}

+
create or update an existing vf-module
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

create or update an existing network-policy

+

create or update an existing vf-module

@@ -76915,13 +79106,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

network-policy object that needs to be created or updated

+

vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

- /network-policy + /vf-module
@@ -76940,10 +79131,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + vnf-id -

UUID representing unique key to this instance

+

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

 path @@ -76985,23 +79192,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing network-policy
-

DELETE /network/network-policies/network-policy/{network-policy-id}

+
update an existing vf-module
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

delete an existing network-policy

+

update an existing vf-module

application/json application/xml

+
+
+

vf-module object that needs to be created or updated.

+

+
+
+
+
+ /vf-module +
+
+
@@ -77017,10 +79236,119 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + +
- network-policy-id + vnf-id -

UUID representing unique key to this instance

+

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 @@ -77078,11 +79406,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network
@@ -77097,7 +79425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

@@ -77122,10 +79450,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + vnf-id -

UUID representing unique key to this instance

+

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

 path @@ -77167,11 +79511,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network
@@ -77199,10 +79543,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + vnf-id -

UUID representing unique key to this instance

+

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ vf-module-id + +

Unique ID of vf-module.

 path @@ -77244,17 +79604,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns newvces
-

GET /network/newvces

+
returns instance-groups
+

GET /network/instance-groups

Tags: Network
-

returns newvces

+

returns instance-groups

@@ -77280,7 +79640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /newvces + /instance-groups
@@ -77308,17 +79668,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns newvce
-

GET /network/newvces/newvce/{vnf-id2}

+
returns instance-group
+

GET /network/instance-groups/instance-group/{id}

Tags: Network
-

returns newvce

+

returns instance-group

@@ -77335,10 +79695,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Instance Group ID, UUID assigned to this instance.

 path @@ -77351,40 +79711,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 + 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.

+

Descriptive text to help identify the usage of this instance-group

 query @@ -77396,10 +79726,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + type -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Only valid value today is lower case ha for high availability

 query @@ -77411,10 +79741,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + sub-type -

Heat stack id corresponding to this instance, managed by MSO

+

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

 query @@ -77450,7 +79780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /newvce + /instance-group
@@ -77478,17 +79808,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing newvce
-

PUT /network/newvces/newvce/{vnf-id2}

+
create or update an existing instance-group
+

PUT /network/instance-groups/instance-group/{id}

Tags: Network
-

create or update an existing newvce

+

create or update an existing instance-group

@@ -77497,13 +79827,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

newvce object that needs to be created or updated

+

instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)

- /newvce + /instance-group
@@ -77522,10 +79852,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Instance Group ID, UUID assigned to this instance.

 path @@ -77567,23 +79897,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing newvce
-

DELETE /network/newvces/newvce/{vnf-id2}

+
update an existing instance-group
+

PATCH /network/instance-groups/instance-group/{id}

Tags: Network
-

delete an existing newvce

+

update an existing instance-group

application/json application/xml

+
+
+

instance-group object that needs to be created or updated.

+

+
+
+
+
+ /instance-group +
+
+
@@ -77599,10 +79941,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vnf-id2 + id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Instance Group ID, UUID assigned to this instance.

 path @@ -77613,22 +79955,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -77660,19 +79986,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interfaces
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

+
delete an existing instance-group
+

DELETE /network/instance-groups/instance-group/{id}

Tags: Network
-

returns l-interfaces

+

delete an existing instance-group

+
+ +

application/json application/xml +

+
@@ -77687,10 +80018,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
- vnf-id2 + id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Instance Group ID, UUID assigned to this instance.

 path @@ -77703,40 +80034,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + resource-version -

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.

+

resource-version for concurrency

 query @@ -77744,42 +80045,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/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/v10/NetworkInstanceGroupsInstanceGroup.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + + +
- prov-status + id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Instance Group ID, UUID assigned to this instance.

querypath 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 +

+
+
+ + + + + + + + + + + - +
- heat-stack-id + id -

Heat stack id corresponding to this instance, managed by MSO

+

Instance Group ID, UUID assigned to this instance.

querypath 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

@@ -77802,7 +80281,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /ipsec-configurations
@@ -77830,17 +80309,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
returns ipsec-configuration
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

returns l-interface

+

returns ipsec-configuration

@@ -77857,26 +80336,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -77887,126 +80350,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -78033,7 +80376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /ipsec-configuration
@@ -78061,17 +80404,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l-interface
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
create or update an existing ipsec-configuration
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing ipsec-configuration

@@ -78080,13 +80423,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

+

ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)

- /l-interface + /ipsec-configuration
@@ -78105,26 +80448,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -78166,23 +80493,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
update an existing ipsec-configuration
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network
-

delete an existing l-interface

+

update an existing ipsec-configuration

application/json application/xml

+
+
+

ipsec-configuration object that needs to be created or updated.

+

+
+
+
+
+ /ipsec-configuration +
+
+
@@ -78198,10 +80537,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id2 + ipsec-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

UUID of this configuration

 path @@ -78212,12 +80551,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ipsec-configuration
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

+ Tags: + Network +
+
+
+

delete an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + +
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -78275,19 +80675,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -78302,10 +80719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id2 + ipsec-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

UUID of this configuration

 path @@ -78316,12 +80733,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + +
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -78332,12 +80810,68 @@ 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 vig-servers
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

+ Tags: + Network +
+
+
+

returns vig-servers

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- l3-interface-ipv4-address + ipsec-configuration-id -

IP address

+

UUID of this configuration

 path @@ -78348,171 +80882,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- 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 - - -
@@ -78539,7 +80908,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vig-servers
@@ -78567,36 +80936,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns vig-server
+

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns vig-server

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -78611,26 +80963,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - +
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -78643,10 +80979,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -78666,6 +81002,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vig-server +
+
+
+ +
default @@ -78688,23 +81047,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing vig-server
+

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing vig-server

application/json application/xml

+
+
+

vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+
+ /vig-server +
+
+
@@ -78720,26 +81091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -78752,10 +81107,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -78766,22 +81121,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -78813,17 +81152,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing vig-server
+

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

see node definition for valid relationships

+

update an existing vig-server

@@ -78832,13 +81171,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

+

vig-server object that needs to be created or updated.

- /relationship + /vig-server
@@ -78857,26 +81196,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -78889,10 +81212,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -78934,17 +81257,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing vig-server
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network
-

delete an existing relationship

+

delete an existing vig-server

@@ -78966,10 +81289,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + ipsec-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

UUID of this configuration

 path @@ -78982,10 +81305,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vig-address-type -

Name given to the interface

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -78998,12 +81321,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -79043,19 +81366,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -79070,10 +81410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id2 + ipsec-configuration-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

UUID of this configuration

 path @@ -79086,10 +81426,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vig-address-type -

Name given to the interface

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -79100,187 +81440,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

- 		query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

- 		query - string - - -
@@ -79290,29 +81449,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
default @@ -79335,35 +81471,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
@@ -79379,26 +81503,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name given to the interface

+

UUID of this configuration

 path @@ -79411,10 +81519,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -79456,24 +81564,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l3-networks
+

GET /network/l3-networks

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

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

-
- -

application/json application/xml -

-
@@ -79488,10 +81655,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -79504,42 +81671,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + network-name -

Name given to the interface

+

Name of the network, governed by some naming convention..

pathquery string -
- l3-interface-ipv6-address + network-role -

IP address

+

Role the network plans - who defines these values?

pathquery string -
- resource-version + service-id -

resource-version for concurrency

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -79547,128 +81712,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + + @@ -79680,6 +81813,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-network +
+
+
+ +
default @@ -79702,23 +81858,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing l3-network
+

PUT /network/l3-networks/l3-network/{network-id}

Tags: Network
-

delete an existing relationship

+

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/v10/NetworkL3NetworksL3Network.json)

+

+
+
+
+
+ /l3-network +
+
+
- vnf-id2 + heat-stack-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- interface-name + contrail-network-fqdn -

Name given to the interface

+

Contrail FQDN for the network

pathquery string -
- l3-interface-ipv6-address + model-invariant-id -

IP address

+

the ASDC model id for this resource or service model.

pathquery + 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 -
@@ -79734,42 +81902,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address + network-id -

IP address

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -79811,17 +81947,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
update an existing l3-network
+

PATCH /network/l3-networks/l3-network/{network-id}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-network

@@ -79830,13 +81966,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

+

l3-network object that needs to be created or updated.

- /relationship + /l3-network
@@ -79855,26 +81991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -79916,17 +82036,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
delete an existing l3-network
+

DELETE /network/l3-networks/l3-network/{network-id}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-network

@@ -79948,10 +82068,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -79964,12 +82084,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name given to the interface

+

resource-version for concurrency

pathquery string @@ -80009,17 +82129,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
returns ctag-assignments
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

Tags: Network
-

returns sriov-vfs

+

returns ctag-assignments

@@ -80036,10 +82156,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80052,26 +82172,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + network-name -

Name given to the interface

+

Name of the network, governed by some naming convention..

pathquery string -
- vnf-name + network-role -

Name of VNF.

+

Role the network plans - who defines these values?

 query @@ -80083,10 +82202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + service-id -

Alternate name of VNF.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -80098,10 +82217,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + heat-stack-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -80113,10 +82232,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + contrail-network-fqdn -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Contrail FQDN for the network

 query @@ -80128,10 +82247,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + model-invariant-id -

Heat stack id corresponding to this instance, managed by MSO

+

the ASDC model id for this resource or service model.

 query @@ -80143,10 +82262,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + model-version-id -

ID of interface

+

the ASDC model version for this resource or service model.

 query @@ -80158,10 +82277,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + widget-model-id -

MAC address for the interface

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -80173,10 +82292,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + widget-model-version -

Name of the network

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -80212,7 +82331,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /ctag-assignments
@@ -80240,17 +82359,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
returns ctag-assignment
+

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network
-

returns sriov-vf

+

returns ctag-assignment

@@ -80267,26 +82386,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80299,14 +82402,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-id-inner -

PCI ID used to identify the sriov-vf

+

id.

 path - string + integer @@ -80315,25 +82418,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 + network-name -

Alternate name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -80345,10 +82433,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + network-role -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Role the network plans - who defines these values?

 query @@ -80360,10 +82448,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + service-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -80390,25 +82478,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr + contrail-network-fqdn -

MAC address for the interface

+

Contrail FQDN for the network

 query @@ -80420,10 +82493,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + model-invariant-id -

Name of the network

+

the ASDC model id for this resource or service model.

 query @@ -80435,10 +82508,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + model-version-id -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

the ASDC model version for this resource or service model.

 query @@ -80450,10 +82523,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + widget-model-id -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -80465,25 +82538,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 + widget-model-version -

Neutron network id of the interface

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -80519,7 +82577,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /ctag-assignment
@@ -80547,17 +82605,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
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 sriov-vf

+

create or update an existing ctag-assignment

@@ -80566,13 +82624,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

+

ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

- /sriov-vf + /ctag-assignment
@@ -80591,26 +82649,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80623,14 +82665,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-id-inner -

PCI ID used to identify the sriov-vf

+

id.

 path - string + integer @@ -80668,23 +82710,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
update an existing ctag-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network
-

delete an existing sriov-vf

+

update an existing ctag-assignment

application/json application/xml

+
+
+

ctag-assignment object that needs to be created or updated.

+

+
+
+
+
+ /ctag-assignment +
+
+
@@ -80700,10 +82754,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80716,26 +82770,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-id-inner -

Name given to the interface

+

id.

 path - string + 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 +

+
+
+ + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - -
- pci-id + network-id -

PCI ID used to identify the sriov-vf

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80746,6 +82861,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
resource-version @@ -80793,11 +82924,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Tags: Network
@@ -80812,7 +82943,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

@@ -80837,26 +82968,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80869,14 +82984,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-id-inner -

PCI ID used to identify the sriov-vf

+

id.

 path - string + integer @@ -80914,11 +83029,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Tags: Network
@@ -80946,26 +83061,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -80978,14 +83077,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-id-inner -

PCI ID used to identify the sriov-vf

+

id.

 path - string + integer @@ -81023,19 +83122,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

Tags: Network
-

returns vlans

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -81050,10 +83166,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - +
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -81064,15 +83180,76 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + + + + + + @@ -81080,27 +83257,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		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

+ +
+
+ + + + + + + + + + + - + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - -
- vnf-name + network-id -

Name of VNF.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- vnf-name2 + network-name -

Alternate name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -81112,10 +83346,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + network-role -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Role the network plans - who defines these values?

 query @@ -81127,10 +83361,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + service-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -81157,10 +83391,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + contrail-network-fqdn -

ID of interface

+

Contrail FQDN for the network

 query @@ -81172,10 +83406,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + model-invariant-id -

MAC address for the interface

+

the ASDC model id for this resource or service model.

 query @@ -81187,10 +83421,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + model-version-id -

Name of the network

+

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 @@ -81226,7 +83490,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /segmentation-assignments
@@ -81254,17 +83518,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns segmentation-assignment
+

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network
-

returns vlan

+

returns segmentation-assignment

@@ -81281,26 +83545,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -81313,10 +83561,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + segmentation-id -

String that identifies the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -81329,25 +83577,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 + network-name -

Alternate name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -81359,10 +83592,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + network-role -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Role the network plans - who defines these values?

 query @@ -81374,10 +83607,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + service-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -81404,10 +83637,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + contrail-network-fqdn -

ID of interface

+

Contrail FQDN for the network

 query @@ -81419,10 +83652,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + model-invariant-id -

MAC address for the interface

+

the ASDC model id for this resource or service model.

 query @@ -81434,10 +83667,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + model-version-id -

Name of the network

+

the ASDC model version for this resource or service model.

 query @@ -81449,14 +83682,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + widget-model-id -

Inner VLAN tag

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query - integer + string @@ -81464,10 +83697,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + widget-model-version -

This indicates the customers VPN ID associated with this vlan

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -81503,7 +83736,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /segmentation-assignment
@@ -81531,17 +83764,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing segmentation-assignment
+

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network
-

create or update an existing vlan

+

create or update an existing segmentation-assignment

@@ -81550,13 +83783,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

- /vlan + /segmentation-assignment
@@ -81575,26 +83808,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -81607,10 +83824,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + segmentation-id -

String that identifies the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -81652,23 +83869,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing segmentation-assignment
+

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network
-

delete an existing vlan

+

update an existing segmentation-assignment

application/json application/xml

+
+
+

segmentation-assignment object that needs to be created or updated.

+

+
+
+
+
+ /segmentation-assignment +
+
+
@@ -81684,26 +83913,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -81716,10 +83929,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + segmentation-id -

String that identifies the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -81730,22 +83943,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -81777,19 +83974,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing segmentation-assignment
+

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

delete an existing segmentation-assignment

+
+ +

application/json application/xml +

+
@@ -81804,10 +84006,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -81820,10 +84022,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + segmentation-id -

Name given to the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -81836,12 +84038,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-version -

String that identifies the interface

+

resource-version for concurrency

pathquery string @@ -81850,12 +84052,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /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/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + + +
- l3-interface-ipv4-address + network-id -

IP address

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -81868,70 +84143,191 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + segmentation-id -

Name of VNF.

+

Route Table Reference id, UUID assigned to this instance.

querypath 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 +

+
+
+ + + + + + + + + + + - + - + + +
- vnf-name2 + network-id -

Alternate name of VNF.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- vnf-type + segmentation-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Route Table Reference id, UUID assigned to this instance.

querypath 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

+ +
+
+ + + + + + + + + + + - +
- prov-status + network-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- heat-stack-id + network-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name of the network, governed by some naming convention..

 query @@ -81943,10 +84339,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-role -

ID of interface

+

Role the network plans - who defines these values?

 query @@ -81958,10 +84354,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + service-id -

MAC address for the interface

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -81973,10 +84369,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + heat-stack-id -

Name of the network

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -81988,14 +84384,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + contrail-network-fqdn -

Inner VLAN tag

+

Contrail FQDN for the network

 query - integer + string @@ -82003,10 +84399,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + model-invariant-id -

This indicates the customers VPN ID associated with this vlan

+

the ASDC model id for this resource or service model.

 query @@ -82018,14 +84414,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + model-version-id -

Inner VLAN tag

+

the ASDC model version for this resource or service model.

 query - integer + string @@ -82033,10 +84429,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + widget-model-id -

Neutron network id of the interface that address belongs to

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -82048,10 +84444,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + widget-model-version -

Neutron id of subnet that address belongs to

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -82087,7 +84483,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /subnets
@@ -82115,36 +84511,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns subnet
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns subnet

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -82159,10 +84538,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -82175,10 +84554,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + subnet-id -

Name given to the interface

+

Subnet ID, should be UUID.

 path @@ -82191,167 +84570,145 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + network-name -

String that identifies the interface

+

Name of the network, governed by some naming convention..

pathquery string -
- l3-interface-ipv4-address + network-role -

IP address

+

Role the network plans - who defines these values?

pathquery 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 -

-
-
- - - - - - - - - - - - + - + - + - + + + + + + + + + + + + + + + + + + + + + + @@ -82371,6 +84727,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /subnet +
+
+
+ +
default @@ -82393,17 +84772,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing subnet
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing subnet

@@ -82412,13 +84791,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

+

subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

- /relationship + /subnet
@@ -82437,10 +84816,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
- vnf-id2 + service-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

pathquery string -
- interface-name + heat-stack-id -

Name given to the interface

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- vlan-interface + contrail-network-fqdn -

String that identifies the interface

+

Contrail FQDN for the network

pathquery string -
- l3-interface-ipv4-address + model-invariant-id -

IP address

+

the ASDC model id for this resource or service model.

pathquery string -
- resource-version + model-version-id -

resource-version for concurrency

+

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 @@ -82359,7 +84716,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- vnf-id2 + network-id -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -82453,10 +84832,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + subnet-id -

Name given to the interface

+

Subnet ID, should be UUID.

 path @@ -82467,12 +84846,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - +
- vlan-interface + network-id -

String that identifies the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -82485,10 +84937,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + subnet-id -

IP address

+

Subnet ID, should be UUID.

 path @@ -82530,17 +84982,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing subnet
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network
-

delete an existing relationship

+

delete an existing subnet

@@ -82562,26 +85014,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -82594,10 +85030,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + subnet-id -

String that identifies the interface

+

Subnet ID, should be UUID.

 path @@ -82610,12 +85046,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -82655,19 +85091,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -82682,42 +85135,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id2 + network-id -

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

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -82730,10 +85151,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + subnet-id -

IP address

+

Subnet ID, should be UUID.

 path @@ -82744,201 +85165,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

- 		query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

- 		query - string - - -
@@ -82948,29 +85174,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
default @@ -82993,35 +85196,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
@@ -83037,42 +85228,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + network-id -

String that identifies the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -83085,10 +85244,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + subnet-id -

IP address

+

Subnet ID, should be UUID.

 path @@ -83130,125 +85289,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns lag-links
+

GET /network/lag-links

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

returns lag-links

-
- -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-links +
+
+
+ +
default @@ -83271,36 +85353,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns lag-link
+

GET /network/lag-links/lag-link/{link-name}

Tags: Network
-

see node definition for valid relationships

+

returns lag-link

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -83315,58 +85380,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + link-name -

IP address

+

Alphabetical concatenation of lag-interface names

 path @@ -83386,6 +85403,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-link +
+
+
+ +
default @@ -83408,23 +85448,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing lag-link
+

PUT /network/lag-links/lag-link/{link-name}

Tags: Network
-

delete an existing relationship

+

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/v10/NetworkLagLinksLagLink.json)

+

+
+
+
+
+ /lag-link +
+
+
@@ -83440,58 +85492,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + link-name -

IP address

+

Alphabetical concatenation of lag-interface names

 path @@ -83533,17 +85537,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
update an existing lag-link
+

PATCH /network/lag-links/lag-link/{link-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing lag-link

@@ -83552,13 +85556,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

+

lag-link object that needs to be created or updated.

- /relationship + /lag-link
@@ -83577,42 +85581,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + link-name -

String that identifies the interface

+

Alphabetical concatenation of lag-interface names

 path @@ -83654,17 +85626,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
delete an existing lag-link
+

DELETE /network/lag-links/lag-link/{link-name}

Tags: Network
-

delete an existing relationship

+

delete an existing lag-link

@@ -83686,26 +85658,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

Alphabetical concatenation of lag-interface names

 path @@ -83718,12 +85674,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-version -

String that identifies the interface

+

resource-version for concurrency

pathquery string @@ -83763,11 +85719,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+

PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -83782,7 +85738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)

@@ -83807,10 +85763,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + link-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Alphabetical concatenation of lag-interface names

 path @@ -83852,11 +85808,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+

DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -83884,10 +85840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + link-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Alphabetical concatenation of lag-interface names

 path @@ -83929,17 +85885,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns physical-links
-

GET /network/physical-links

+
returns logical-links
+

GET /network/logical-links

Tags: Network
-

returns physical-links

+

returns logical-links

@@ -83965,7 +85921,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /physical-links + /logical-links
@@ -83993,17 +85949,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns physical-link
-

GET /network/physical-links/physical-link/{link-name}

+
returns logical-link
+

GET /network/logical-links/logical-link/{link-name}

Tags: Network
-

returns physical-link

+

returns logical-link

@@ -84023,7 +85979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen link-name
-

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path @@ -84034,12 +85990,117 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+ 		query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+ 		query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+ 		query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ link-id + +

UUID of the logical-link, SDNC generates this.

+ 		query + string + + +
circuit-id -

Circuit it

+

Circuit id

+ 		query + string + + +
+ purpose + +

Reason for this entity, role it is playing

 query @@ -84075,7 +86136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /physical-link + /logical-link
@@ -84103,17 +86164,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing physical-link
-

PUT /network/physical-links/physical-link/{link-name}

+
create or update an existing logical-link
+

PUT /network/logical-links/logical-link/{link-name}

Tags: Network
-

create or update an existing physical-link

+

create or update an existing logical-link

@@ -84122,13 +86183,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

physical-link object that needs to be created or updated

+

logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)

- /physical-link + /logical-link
@@ -84150,7 +86211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen link-name
-

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path @@ -84192,23 +86253,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing physical-link
-

DELETE /network/physical-links/physical-link/{link-name}

+
update an existing logical-link
+

PATCH /network/logical-links/logical-link/{link-name}

Tags: Network
-

delete an existing physical-link

+

update an existing logical-link

application/json application/xml

+
+
+

logical-link object that needs to be created or updated.

+

+
+
+
+
+ /logical-link +
+
+
@@ -84227,7 +86300,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen link-name + + + + + +
-

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

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 @@ -84285,11 +86435,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

+

PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -84304,7 +86454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)

@@ -84332,7 +86482,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen link-name
-

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path @@ -84374,11 +86524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

+

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -84409,7 +86559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen link-name
-

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path @@ -84451,17 +86601,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns pnfs
-

GET /network/pnfs

+
returns multicast-configurations
+

GET /network/multicast-configurations

Tags: Network
-

returns pnfs

+

returns multicast-configurations

@@ -84487,7 +86637,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pnfs + /multicast-configurations
@@ -84515,17 +86665,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns pnf
-

GET /network/pnfs/pnf/{pnf-name}

+
returns multicast-configuration
+

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

returns pnf

+

returns multicast-configuration

@@ -84542,10 +86692,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + multicast-configuration-id -

unique name of Physical Network Function.

+

Unique id of multicast configuration.

 path @@ -84556,21 +86706,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
@@ -84597,7 +86732,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pnf + /multicast-configuration
@@ -84625,17 +86760,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing pnf
-

PUT /network/pnfs/pnf/{pnf-name}

+
create or update an existing multicast-configuration
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

create or update an existing pnf

+

create or update an existing multicast-configuration

@@ -84644,13 +86779,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

pnf object that needs to be created or updated

+

multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)

- /pnf + /multicast-configuration
@@ -84669,10 +86804,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + multicast-configuration-id -

unique name of Physical Network Function.

+

Unique id of multicast configuration.

 path @@ -84714,23 +86849,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing pnf
-

DELETE /network/pnfs/pnf/{pnf-name}

+
update an existing multicast-configuration
+

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

delete an existing pnf

+

update an existing multicast-configuration

application/json application/xml

+
+
+

multicast-configuration object that needs to be created or updated.

+

+
+
+
+
+ /multicast-configuration +
+
+
@@ -84746,10 +86893,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- pnf-name + multicast-configuration-id -

unique name of Physical Network Function.

+

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 @@ -84807,19 +87031,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

+
see node definition for valid relationships
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-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. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -84834,10 +87075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + multicast-configuration-id -

unique name of Physical Network Function.

+

Unique id of multicast configuration.

 path @@ -84848,25 +87089,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/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - +
- inv-status + multicast-configuration-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Unique id of multicast configuration.

querypath 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

@@ -84889,7 +87233,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /network-policies
@@ -84917,17 +87261,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns lag-interface
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+
returns network-policy
+

GET /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

returns lag-interface

+

returns network-policy

@@ -84944,26 +87288,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + network-policy-id -

Name that identifies the link aggregate interface

+

UUID representing unique key to this instance

 path @@ -84976,40 +87304,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + network-policy-fqdn -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Contrail FQDN for the policy

 query @@ -85045,7 +87343,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /network-policy
@@ -85073,17 +87371,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+
create or update an existing network-policy
+

PUT /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

create or update an existing lag-interface

+

create or update an existing network-policy

@@ -85092,13 +87390,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

+

network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)

- /lag-interface + /network-policy
@@ -85117,26 +87415,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + network-policy-id -

Name that identifies the link aggregate interface

+

UUID representing unique key to this instance

 path @@ -85178,23 +87460,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+
update an existing network-policy
+

PATCH /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

delete an existing lag-interface

+

update an existing network-policy

application/json application/xml

+
+
+

network-policy object that needs to be created or updated.

+

+
+
+
+
+ /network-policy +
+
+
@@ -85210,10 +87504,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + network-policy-id -

unique name of Physical Network Function.

+

UUID representing unique key to this instance

 path @@ -85224,12 +87518,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing network-policy
+

DELETE /network/network-policies/network-policy/{network-policy-id}

+ Tags: + Network +
+
+
+

delete an existing network-policy

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + network-policy-id -

Name that identifies the link aggregate interface

+

UUID representing unique key to this instance

 path @@ -85287,19 +87642,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+
see node definition for valid relationships
+

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -85314,10 +87686,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + network-policy-id -

unique name of Physical Network Function.

+

UUID representing unique key to this instance

 path @@ -85328,12 +87700,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - -
- interface-name + network-policy-id -

Name that identifies the link aggregate interface

+

UUID representing unique key to this instance

 path @@ -85344,55 +87777,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
+
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns newvces
+

GET /network/newvces

+ Tags: + Network +
+
+
+

returns newvces

+ +
+

application/json application/xml

@@ -85415,7 +87844,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /newvces
@@ -85443,17 +87872,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns newvce
+

GET /network/newvces/newvce/{vnf-id2}

Tags: Network
-

returns l-interface

+

returns newvce

@@ -85470,42 +87899,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + vnf-id2 -

Name given to the interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -85518,25 +87915,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- interface-id + vnf-name -

ID of interface

+

Name of VNF.

 query @@ -85548,10 +87930,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + vnf-name2 -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Alternate name of VNF.

 query @@ -85563,10 +87945,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-type -

ID of interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -85578,10 +87960,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + prov-status -

MAC address for the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -85593,10 +87975,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + heat-stack-id -

Name of the network

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -85632,7 +88014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /newvce
@@ -85660,17 +88042,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
create or update an existing newvce
+

PUT /network/newvces/newvce/{vnf-id2}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing newvce

@@ -85679,13 +88061,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

+

newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)

- /l-interface + /newvce
@@ -85704,42 +88086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + vnf-id2 -

Name given to the interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -85781,23 +88131,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing newvce
+

PATCH /network/newvces/newvce/{vnf-id2}

Tags: Network
-

delete an existing l-interface

+

update an existing newvce

application/json application/xml

+
+
+

newvce object that needs to be created or updated.

+

+
+
+
+
+ /newvce +
+
+
@@ -85813,26 +88175,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -85843,12 +88189,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing newvce
+

DELETE /network/newvces/newvce/{vnf-id2}

+ Tags: + Network +
+
+
+

delete an existing newvce

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- interface-name + vnf-id2 -

Name given to the interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -85906,17 +88313,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interfaces
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns l-interfaces

@@ -85933,58 +88340,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vnf-id2 -

IP address

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -85997,55 +88356,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- 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 + vnf-name -

ID of interface

+

Name of VNF.

 query @@ -86057,10 +88371,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vnf-name2 -

MAC address for the interface

+

Alternate name of VNF.

 query @@ -86072,10 +88386,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vnf-type -

Name of the network

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -86087,25 +88401,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 + prov-status -

Neutron network id of the interface that address belongs to

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -86117,10 +88416,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + heat-stack-id -

Neutron id of subnet that address belongs to

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -86156,7 +88455,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l-interfaces
@@ -86184,36 +88483,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns l-interface
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns l-interface

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -86228,10 +88510,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86247,7 +88529,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 given to the interface

 path @@ -86260,167 +88542,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vnf-name -

Name given to the interface

+

Name of VNF.

pathquery string -
- l3-interface-ipv4-address + vnf-name2 -

IP address

+

Alternate name of VNF.

pathquery 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 -

-
-
- - - - - - - - - - - - + - + - + - + + + + + + + + @@ -86440,6 +88669,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
default @@ -86462,17 +88714,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
create or update an existing l-interface
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing l-interface

@@ -86481,13 +88733,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

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)

- /relationship + /l-interface
@@ -86506,10 +88758,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
- pnf-name + vnf-type -

unique name of Physical Network Function.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery string -
- interface-name + prov-status -

Name that identifies the link aggregate interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- interface-name + heat-stack-id -

Name given to the interface

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- l3-interface-ipv4-address + interface-id -

IP address

+

ID of interface

pathquery string -
- resource-version + macaddr -

resource-version for concurrency

+

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

 query @@ -86428,7 +88658,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86525,7 +88777,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 given to the interface

 path @@ -86536,12 +88788,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - + - + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + vnf-id2 -

Name given to the interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86554,10 +88879,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 @@ -86599,17 +88924,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing l-interface
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

delete an existing l-interface

@@ -86631,26 +88956,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86679,12 +88988,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -86724,17 +89033,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns 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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -86751,10 +89060,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86770,7 +89079,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 given to the interface

 path @@ -86783,10 +89092,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -86799,26 +89108,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vnf-name -

IP address

+

Name of VNF.

pathquery string -
- inv-status + vnf-name2 -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Alternate name of VNF.

 query @@ -86830,10 +89138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-type -

ID of interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -86845,10 +89153,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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 @@ -86974,7 +89297,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -87002,17 +89325,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing 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-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -87021,13 +89344,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -87046,151 +89369,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -87219,7 +89401,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -87233,22 +89415,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -87280,17 +89446,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -87299,13 +89465,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

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -87324,26 +89490,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -87372,7 +89522,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -87417,17 +89567,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -87449,10 +89599,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -87468,7 +89618,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 given to the interface

 path @@ -87481,10 +89631,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -87497,12 +89647,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -87542,11 +89692,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -87561,7 +89711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -87586,10 +89736,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -87605,7 +89755,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 given to the interface

 path @@ -87618,10 +89768,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -87663,11 +89813,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -87695,10 +89845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -87714,7 +89864,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 given to the interface

 path @@ -87727,10 +89877,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -87772,17 +89922,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
returns l3-interface-ipv6-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns sriov-vfs

+

returns l3-interface-ipv6-address-list

@@ -87799,10 +89949,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -87818,7 +89968,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 given to the interface

 path @@ -87831,10 +89981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv6-address -

Name given to the interface

+

IP address

 path @@ -87847,10 +89997,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + vnf-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name of VNF.

 query @@ -87862,10 +90012,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-name2 -

ID of interface

+

Alternate name of VNF.

 query @@ -87877,10 +90027,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + vnf-type -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -87935,6 +90115,51 @@ 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 + +

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 + + +
@@ -87961,7 +90186,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l3-interface-ipv6-address-list
@@ -87989,19 +90214,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -88016,10 +90258,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88035,7 +90277,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 given to the interface

 path @@ -88048,10 +90290,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv6-address -

Name given to the interface

+

IP address

 path @@ -88062,12 +90304,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + + +
- pci-id + vnf-id2 -

PCI ID used to identify the sriov-vf

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88080,145 +90395,151 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + l3-interface-ipv6-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing 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 +

+
+
+ + + + + + + + + + + - + - + - + - - - - - - - @@ -88237,29 +90559,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -88282,17 +90581,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

create or update an existing sriov-vf

+

see node definition for valid relationships

@@ -88301,13 +90600,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /sriov-vf + /relationship
@@ -88326,26 +90625,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- network-name + vnf-id2 -

Name of the network

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name given to the interface

querypath string +
- vf-mac-filter + l3-interface-ipv6-address -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

IP address

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

- 		query - boolean - - -
- neutron-network-id + resource-version -

Neutron network id of the interface

+

resource-version for concurrency

 query @@ -88226,6 +90547,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88374,10 +90657,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -88419,17 +90702,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -88451,26 +90734,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88499,10 +90766,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -88513,22 +90780,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -88560,11 +90811,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -88579,7 +90830,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)

@@ -88604,26 +90855,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88650,22 +90885,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -88697,11 +90916,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -88729,26 +90948,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88775,22 +90978,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -88822,17 +91009,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlans
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns sriov-vfs
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

returns vlans

+

returns sriov-vfs

@@ -88849,10 +91036,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -88868,7 +91055,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 given to the interface

 path @@ -88881,26 +91068,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vnf-name -

Name given to the interface

+

Name of VNF.

pathquery string -
- inv-status + vnf-name2 -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Alternate name of VNF.

 query @@ -88912,10 +91098,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-type -

ID of interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -88927,10 +91113,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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 @@ -89011,7 +91212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /sriov-vfs
@@ -89039,17 +91240,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns sriov-vf
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns vlan

+

returns sriov-vf

@@ -89066,10 +91267,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -89085,7 +91286,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 given to the interface

 path @@ -89098,10 +91299,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + pci-id -

Name given to the interface

+

PCI ID used to identify the sriov-vf

 path @@ -89114,26 +91315,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vnf-name -

String that identifies the interface

+

Name of VNF.

pathquery string -
- inv-status + vnf-name2 -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Alternate name of VNF.

 query @@ -89145,10 +91345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-type -

ID of interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -89160,10 +91360,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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 @@ -89220,14 +91435,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vf-vlan-filter -

Inner VLAN tag

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query - integer + string @@ -89235,10 +91450,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + vf-mac-filter -

This indicates the customers VPN ID associated with this vlan

+

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 @@ -89274,7 +91519,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /sriov-vf
@@ -89302,17 +91547,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing sriov-vf
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

create or update an existing vlan

+

create or update an existing sriov-vf

@@ -89321,13 +91566,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /vlan + /sriov-vf
@@ -89346,26 +91591,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -89394,10 +91623,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -89439,23 +91668,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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
-

delete an existing vlan

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -89471,10 +91712,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -89490,7 +91731,100 @@ 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 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 @@ -89519,10 +91853,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -89580,19 +91914,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -89607,10 +91958,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -89626,7 +91977,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 given to the interface

 path @@ -89639,10 +91990,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + pci-id -

Name given to the interface

+

PCI ID used to identify the sriov-vf

 path @@ -89653,12 +92004,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + + +
- vlan-interface + vnf-id2 -

String that identifies the interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -89671,10 +92083,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 @@ -89687,55 +92099,114 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + pci-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+ Tags: + Network +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - -
- interface-id + vnf-id2 -

ID of interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name given to the interface

querypath string +
- interface-id + vnf-name -

ID of interface

+

Name of VNF.

 query @@ -89747,10 +92218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vnf-name2 -

MAC address for the interface

+

Alternate name of VNF.

 query @@ -89762,10 +92233,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vnf-type -

Name of the network

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -89777,14 +92248,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + prov-status -

Inner VLAN tag

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query - integer + string @@ -89792,10 +92263,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + heat-stack-id -

This indicates the customers VPN ID associated with this vlan

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -89807,14 +92278,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-id -

Inner VLAN tag

+

ID of interface

 query - integer + string @@ -89822,10 +92293,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + macaddr -

Neutron network id of the interface that address belongs to

+

MAC address for the interface

 query @@ -89837,10 +92308,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + network-name -

Neutron id of subnet that address belongs to

+

Name of the network

 query @@ -89876,7 +92347,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vlans
@@ -89904,36 +92375,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns vlan
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns vlan

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -89948,10 +92402,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -90035,6 +92607,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -90057,23 +92652,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing vlan
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -89967,7 +92421,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 given to the interface

 path @@ -89980,10 +92434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -89996,34 +92450,152 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vnf-name -

String that identifies the interface

+

Name of VNF.

pathquery string -
- l3-interface-ipv4-address + vnf-name2 -

IP address

+

Alternate name of VNF.

pathquery + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query string -
@@ -90089,26 +92696,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -90151,38 +92742,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -90214,17 +92773,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing vlan
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

see node definition for valid relationships

+

update an existing vlan

@@ -90233,13 +92792,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

+

vlan object that needs to be created or updated.

- /relationship + /vlan
@@ -90258,26 +92817,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -90320,22 +92863,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -90367,17 +92894,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing vlan
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing relationship

+

delete an existing vlan

@@ -90399,26 +92926,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -90463,12 +92974,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -90508,17 +93019,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l3-interface-ipv4-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns l3-interface-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -90535,10 +93046,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -90554,7 +93065,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 given to the interface

 path @@ -90567,10 +93078,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -90583,10 +93094,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -90599,26 +93110,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vnf-name -

IP address

+

Name of VNF.

pathquery string -
- inv-status + vnf-name2 -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Alternate name of VNF.

 query @@ -90630,10 +93140,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-type -

ID of interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -90645,10 +93155,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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 @@ -90804,7 +93329,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -90832,17 +93357,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -90851,13 +93376,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -90876,26 +93401,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -90940,7 +93449,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -90985,23 +93494,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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-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
-

delete an existing l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -91017,10 +93538,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91036,7 +93557,116 @@ 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 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 @@ -91081,7 +93711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -91142,11 +93772,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

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
@@ -91161,7 +93791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -91186,26 +93816,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91250,7 +93864,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -91295,11 +93909,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/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
@@ -91327,26 +93941,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91391,7 +93989,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -91436,36 +94034,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -91480,26 +94061,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + vnf-id2 -

Name that identifies the link aggregate interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91542,6 +94107,217 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+ vnf-name + +

Name of VNF.

+ 		query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+ 		query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ 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 + + +
@@ -91551,6 +94327,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
default @@ -91573,23 +94372,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
@@ -91605,10 +94416,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91624,7 +94435,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 given to the interface

 path @@ -91637,10 +94448,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -91653,10 +94464,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -91698,17 +94509,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -91717,13 +94528,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

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -91742,10 +94553,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91761,7 +94572,39 @@ 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 given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -91803,17 +94646,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -91835,10 +94678,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91854,7 +94697,39 @@ 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 given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -91865,6 +94740,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -91896,19 +94787,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns p-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

+
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
-

returns p-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -91923,10 +94831,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -91961,29 +94902,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interfaces -
-
-
- -
default @@ -92006,19 +94924,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interface
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+
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
-

returns p-interface

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -91939,17 +94847,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string +
@@ -92033,10 +94956,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -92102,29 +95027,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interface -
-
-
- -
default @@ -92147,17 +95049,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing p-interface
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+
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
-

create or update an existing p-interface

+

see node definition for valid relationships

@@ -92166,13 +95068,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

- /p-interface + /relationship
@@ -92191,10 +95093,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -92052,7 +94975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

+

Name given to the interface

 path @@ -92065,32 +94988,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + vlan-interface -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

String that identifies the interface

querypath string +
- prov-status + l3-interface-ipv6-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -92210,7 +95112,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -92252,17 +95170,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing p-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+
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 p-interface

+

delete an existing relationship

@@ -92284,10 +95202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -92303,7 +95221,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the physical interface

+

Name given to the interface

 path @@ -92316,12 +95234,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath string @@ -92361,19 +95279,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

Tags: Network
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -92388,10 +95323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + vnf-id2 -

unique name of Physical Network Function.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -92402,12 +95337,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - -
- interface-name + vnf-id2 -

Name that identifies the physical interface

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -92418,40 +95414,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
+
+

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

@@ -92474,7 +95481,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /physical-links
@@ -92502,17 +95509,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns physical-link
+

GET /network/physical-links/physical-link/{link-name}

Tags: Network
-

returns l-interface

+

returns physical-link

@@ -92529,42 +95536,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -92577,70 +95552,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- 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 + circuit-id -

Name of the network

+

Circuit it

 query @@ -92676,7 +95591,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /physical-link
@@ -92704,17 +95619,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
create or update an existing physical-link
+

PUT /network/physical-links/physical-link/{link-name}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing physical-link

@@ -92723,13 +95638,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

+

physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)

- /l-interface + /physical-link
@@ -92748,42 +95663,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -92825,23 +95708,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing physical-link
+

PATCH /network/physical-links/physical-link/{link-name}

Tags: Network
-

delete an existing l-interface

+

update an existing physical-link

application/json application/xml

+
+
+

physical-link object that needs to be created or updated.

+

+
+
+
+
+ /physical-link +
+
+
@@ -92857,42 +95752,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -92903,22 +95766,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -92950,19 +95797,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing physical-link
+

DELETE /network/physical-links/physical-link/{link-name}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

delete an existing physical-link

+
+ +

application/json application/xml +

+
@@ -92977,26 +95829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + link-name -

Name that identifies the physical interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -93009,12 +95845,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name given to the interface

+

resource-version for concurrency

pathquery string @@ -93023,146 +95859,217 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/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/v10/NetworkPhysicalLinksPhysicalLink.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
- 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 + link-name -

Neutron network id of the interface that address belongs to

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

querypath 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 +

+
+
+ + + + + + + + + + + - +
- neutron-subnet-id + link-name -

Neutron id of subnet that address belongs to

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

querypath 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

@@ -93185,7 +96092,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /pnfs
@@ -93213,36 +96120,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns pnf
+

GET /network/pnfs/pnf/{pnf-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns pnf

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -93273,50 +96163,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -93328,6 +96185,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /pnf +
+
+
+ +
default @@ -93350,23 +96230,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
create or update an existing pnf
+

PUT /network/pnfs/pnf/{pnf-name}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

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/v10/NetworkPnfsPnf.json)

+

+
+
+
+
+ /pnf +
+
+
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv4-address + inv-status -

IP address

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
@@ -93396,70 +96288,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- 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 - - - -
@@ -93491,17 +96319,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
update an existing pnf
+

PATCH /network/pnfs/pnf/{pnf-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing pnf

@@ -93510,13 +96338,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

+

pnf object that needs to be created or updated.

- /relationship + /pnf
@@ -93549,54 +96377,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -93628,17 +96408,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
delete an existing pnf
+

DELETE /network/pnfs/pnf/{pnf-name}

Tags: Network
-

delete an existing relationship

+

delete an existing pnf

@@ -93676,12 +96456,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name that identifies the physical interface

+

resource-version for concurrency

pathquery string @@ -93690,12 +96470,68 @@ 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 lag-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + - + @@ -93731,6 +96566,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
default @@ -93753,17 +96611,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns lag-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

returns l3-interface-ipv6-address-list

+

returns lag-interface

@@ -93799,39 +96657,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + pnf-name -

Name given to the interface

+

unique name of Physical Network Function.

 path @@ -93708,18 +96544,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + inv-status -

IP address

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
-

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

+

Name that identifies the link aggregate interface

 path @@ -93857,21 +96683,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
interface-id @@ -93889,70 +96700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

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 + interface-role -

Neutron id of subnet that address belongs to

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -93988,7 +96739,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /lag-interface
@@ -94016,17 +96767,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/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 lag-interface
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing lag-interface

@@ -94035,13 +96786,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

+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)

- /l3-interface-ipv6-address-list + /lag-interface
@@ -94079,39 +96830,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

+

Name that identifies the link aggregate interface

 path @@ -94153,23 +96872,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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 lag-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+
+ /lag-interface +
+
+
@@ -94204,39 +96935,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - -
-

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

+

Name that identifies the link aggregate interface

 path @@ -94247,22 +96946,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -94294,35 +96977,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/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 lag-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

delete an existing lag-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -94357,23 +97028,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -94386,12 +97041,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -94431,24 +97086,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns l-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -94482,7 +97132,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + + + + + + + + @@ -94534,6 +97197,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -94556,36 +97242,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

returns l-interface

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -94495,34 +97145,47 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + inv-status -

Name given to the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- l3-interface-ipv6-address + interface-id -

IP address

+

ID of interface

pathquery + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query string -
@@ -94619,7 +97288,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -94646,54 +97315,179 @@ 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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
+
+ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
-
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

+
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
-

delete an existing relationship

+

create or update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
@@ -94728,7 +97522,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -94786,19 +97580,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
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
-

returns sriov-vfs

+

update an existing l-interface

+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
+
@@ -94832,7 +97643,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -94859,72 +97670,121 @@ 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 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 +

+
+
+ + + + + + + + + + + - - - - - - - - + - + - + @@ -94943,29 +97804,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -94988,17 +97826,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

returns l3-interface-ipv4-address-list

@@ -95034,7 +97872,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- prov-status + pnf-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

unique name of Physical Network Function.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

 query @@ -94932,6 +97792,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -95063,10 +97901,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -95094,10 +97932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of interface

 query @@ -95109,10 +97947,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-role -

ID of interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -95124,10 +97962,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + interface-id -

MAC address for the interface

+

ID of interface

 query @@ -95139,10 +97977,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + macaddr -

Name of the network

+

MAC address for the interface

 query @@ -95154,10 +97992,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + network-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name of the network

 query @@ -95169,14 +98007,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + vlan-id-inner -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Inner VLAN tag

 query - string + integer @@ -95184,14 +98022,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + neutron-network-id -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

Neutron network id of the interface that address belongs to

 query - boolean + string @@ -95199,10 +98037,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + neutron-subnet-id -

Neutron network id of the interface

+

Neutron id of subnet that address belongs to

 query @@ -95238,7 +98076,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l3-interface-ipv4-address-list
@@ -95266,17 +98104,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/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 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 sriov-vf

+

create or update an existing l3-interface-ipv4-address-list

@@ -95285,13 +98123,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

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /sriov-vf + /l3-interface-ipv4-address-list
@@ -95329,7 +98167,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -95358,10 +98196,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -95403,23 +98241,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing sriov-vf

+

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 +
+
+
@@ -95454,7 +98304,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -95483,10 +98333,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -95497,22 +98347,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -95544,35 +98378,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -95607,7 +98429,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -95636,10 +98458,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -95650,6 +98472,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -95681,23 +98519,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/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
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -95732,7 +98582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -95761,10 +98611,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -95806,19 +98656,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

returns vlans

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -95852,7 +98707,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -95963,29 +98759,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -96008,17 +98781,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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 vlan

+

returns l3-interface-ipv6-address-list

@@ -96054,7 +98827,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -95881,77 +98736,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- 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 + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -96083,10 +98856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -96114,10 +98887,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -96189,10 +98977,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + neutron-network-id -

This indicates the customers VPN ID associated with this vlan

+

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -96228,7 +99031,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l3-interface-ipv6-address-list
@@ -96256,17 +99059,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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 vlan

+

create or update an existing l3-interface-ipv6-address-list

@@ -96275,13 +99078,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /vlan + /l3-interface-ipv6-address-list
@@ -96319,7 +99122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -96348,10 +99151,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -96393,23 +99196,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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
-

delete an existing vlan

+

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 +
+
+
@@ -96444,7 +99259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -96473,10 +99288,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -96487,22 +99302,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -96534,19 +99333,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
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
-

returns l3-interface-ipv4-address-list

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -96580,7 +99384,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -96798,29 +99452,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -96843,17 +99474,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/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
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -96862,13 +99493,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

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /relationship
@@ -96906,7 +99537,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - - - - - - - - - - - - - - - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -96609,23 +99413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -96641,145 +99429,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

- 		query - string - - -
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -96787,6 +99440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -96935,23 +99566,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -96996,17 +99611,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/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 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 l3-interface-ipv4-address-list

+

delete an existing relationship

@@ -97047,7 +99662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -97076,23 +99691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -97106,22 +99705,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -97153,11 +99736,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -97172,7 +99755,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -97216,7 +99799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -97243,12 +99826,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface + pnf-name -

String that identifies the interface

+

unique name of Physical Network Function.

 path @@ -97261,10 +99905,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -97306,24 +99966,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns sriov-vfs
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

delete an existing relationship

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -97357,7 +100012,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -97425,6 +100138,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
default @@ -97447,17 +100183,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/pnfs/pnf/{pnf-name}/p-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 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 l3-interface-ipv6-address-list

+

returns sriov-vf

@@ -97493,7 +100229,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -97386,34 +100041,92 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + inv-status -

String that identifies the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- l3-interface-ipv4-address + interface-id -

IP address

+

ID of interface

pathquery + 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 -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -97522,10 +100258,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -97538,26 +100274,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + inv-status -

IP address

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- inv-status + interface-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of interface

 query @@ -97569,10 +100304,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-role -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -97629,14 +100364,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vf-vlan-filter -

Inner VLAN tag

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query - integer + string @@ -97644,10 +100379,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + vf-mac-filter -

This indicates the customers VPN ID associated with this vlan

+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query @@ -97659,14 +100394,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vf-vlan-strip -

Inner VLAN tag

+

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query - integer + boolean @@ -97677,22 +100412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

+

Neutron network id of the interface

 query @@ -97728,7 +100448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /sriov-vf
@@ -97756,17 +100476,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/pnfs/pnf/{pnf-name}/p-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 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 l3-interface-ipv6-address-list

+

create or update an existing sriov-vf

@@ -97775,13 +100495,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

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /l3-interface-ipv6-address-list + /sriov-vf
@@ -97819,148 +100539,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

- 		path - string - - - -
- 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

+

Name that identifies the link aggregate interface

 path @@ -97989,26 +100568,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -98019,22 +100582,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -98066,17 +100613,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing sriov-vf

@@ -98085,13 +100632,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

+

sriov-vf object that needs to be created or updated.

- /relationship + /sriov-vf
@@ -98129,7 +100676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -98158,26 +100705,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -98219,17 +100750,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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 relationship

+

delete an existing sriov-vf

@@ -98270,7 +100801,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -98299,10 +100830,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -98315,12 +100846,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -98360,11 +100891,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -98379,7 +100910,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -98423,7 +100954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -98452,10 +100983,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -98497,11 +101028,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -98548,7 +101079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -98577,10 +101108,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -98622,36 +101153,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

see node definition for valid relationships

+

returns vlans

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -98685,7 +101199,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -98696,6 +101226,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
@@ -98705,6 +101325,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
default @@ -98727,24 +101370,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
returns 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
-

delete an existing relationship

+

returns vlan

-
- -

application/json application/xml -

-
@@ -98778,7 +101416,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

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 @@ -98789,6 +101459,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
@@ -98798,6 +101588,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -98820,17 +101633,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing vlan

@@ -98839,13 +101652,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

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

- /relationship + /vlan
@@ -98878,6 +101691,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -98909,23 +101770,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+
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
-

delete an existing relationship

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -98955,6 +101828,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -98986,48 +101907,125 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns route-table-references
-

GET /network/route-table-references

+
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
-

returns route-table-references

+

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /route-table-references -
-
-
- -
default @@ -99050,17 +102048,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns route-table-reference
-

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

+
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 route-table-reference

+

returns l3-interface-ipv4-address-list

@@ -99077,10 +102075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-id + pnf-name -

Route Table Reference id, UUID assigned to this instance.

+

unique name of Physical Network Function.

 path @@ -99093,10 +102091,224 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-fqdn + interface-name -

FQDN entry in the route table.

+

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-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 @@ -99132,7 +102344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-table-reference + /l3-interface-ipv4-address-list
@@ -99160,17 +102372,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing route-table-reference
-

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

+
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 route-table-reference

+

create or update an existing l3-interface-ipv4-address-list

@@ -99179,13 +102391,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

route-table-reference object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /route-table-reference + /l3-interface-ipv4-address-list
@@ -99204,10 +102416,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-id + pnf-name -

Route Table Reference id, UUID assigned to this instance.

+

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 @@ -99249,23 +102525,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing route-table-reference
-

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

+
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
-

delete an existing route-table-reference

+

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 +
+
+
@@ -99281,10 +102569,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + +
- route-table-reference-id + pnf-name -

Route Table Reference id, UUID assigned to this instance.

+

unique name of Physical Network Function.

 path @@ -99297,12 +102585,60 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path string @@ -99342,35 +102678,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -99386,10 +102710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- route-table-reference-id + pnf-name -

Route Table Reference id, UUID assigned to this instance.

+

unique name of Physical Network Function.

 path @@ -99400,73 +102724,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/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 + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name that identifies the link aggregate interface

 path @@ -99477,132 +102740,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 + interface-name -

Unique id of site pair set.

+

Name given to the interface

 path @@ -99613,108 +102756,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

-

-
-
-
-
- /site-pair-set -
-
-
-
-
- - - - - - - - - - - - -
- site-pair-set-id + vlan-interface -

Unique id of site pair set.

+

String that identifies the interface

 path @@ -99725,73 +102772,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + l3-interface-ipv4-address -

Unique id of site pair set.

+

IP address

 path @@ -99849,11 +102835,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

+

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
@@ -99868,7 +102854,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -99893,10 +102879,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

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 @@ -99938,11 +102988,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/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
@@ -99970,10 +103020,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

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 @@ -100015,17 +103129,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns routing-instances
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

+
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 routing-instances

+

returns l3-interface-ipv6-address-list

@@ -100042,10 +103156,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

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 @@ -100056,6 +103234,171 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ 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 + + +
@@ -100082,7 +103425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /routing-instances + /l3-interface-ipv6-address-list
@@ -100110,19 +103453,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns routing-instance
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns routing-instance

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -100137,10 +103497,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100153,10 +103513,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

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 @@ -100176,29 +103584,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /routing-instance -
-
-
- -
default @@ -100221,17 +103606,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing routing-instance

+

update an existing l3-interface-ipv6-address-list

@@ -100240,13 +103625,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

routing-instance object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /routing-instance + /l3-interface-ipv6-address-list
@@ -100265,10 +103650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100281,10 +103666,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

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 @@ -100326,17 +103759,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete 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 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 routing-instance

+

delete an existing l3-interface-ipv6-address-list

@@ -100358,10 +103791,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100374,10 +103807,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

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 @@ -100435,11 +103916,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -100454,7 +103935,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -100479,10 +103960,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100495,10 +103976,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the link aggregate interface

 path @@ -100509,73 +103990,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/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 + interface-name -

Unique id of site pair set.

+

Name given to the interface

 path @@ -100588,10 +104008,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + vlan-interface -

Unique id of routing instance

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -100633,19 +104069,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns site-pairs
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

+
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
-

returns site-pairs

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -100660,10 +104101,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100676,10 +104117,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

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 @@ -100699,29 +104188,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pairs -
-
-
- -
default @@ -100744,19 +104210,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns site-pair

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -100771,10 +104254,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100787,10 +104270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the link aggregate interface

 path @@ -100803,10 +104286,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + interface-name -

unique identifier of probe

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -100826,29 +104325,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pair -
-
-
- -
default @@ -100871,35 +104347,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing site-pair

+

delete an existing relationship

application/json application/xml

-
-
-

site-pair object that needs to be created or updated

-

-
-
-
-
- /site-pair -
-
-
@@ -100915,10 +104379,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -100931,10 +104395,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the link aggregate interface

 path @@ -100947,10 +104411,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + interface-name -

unique identifier of probe

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -100992,23 +104472,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

delete an existing site-pair

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -101024,10 +104516,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -101040,10 +104532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the link aggregate interface

 path @@ -101054,12 +104546,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - + @@ -101216,7 +104752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /classes-of-service + /p-interfaces
@@ -101244,17 +104780,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns p-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

returns class-of-service

+

returns p-interface

@@ -101271,10 +104807,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- + - + @@ -101359,7 +104893,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /class-of-service + /p-interface
@@ -101387,17 +104921,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 class-of-service

+

create or update an existing p-interface

@@ -101406,13 +104940,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

class-of-service object that needs to be created or updated

+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)

- /class-of-service + /p-interface
@@ -101431,42 +104965,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - -
- site-pair-id + pnf-name -

unique identifier of probe

+

unique name of Physical Network Function.

 path @@ -101072,12 +104625,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath string @@ -101117,17 +104670,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns p-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

Tags: Network
-

returns classes-of-service

+

returns p-interfaces

@@ -101144,26 +104697,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
- routing-instance-id + pnf-name -

Unique id of routing instance

+

unique name of Physical Network Function.

 path @@ -101176,18 +104713,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + inv-status -

unique identifier of probe

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -101287,10 +104823,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the physical interface

 path @@ -101303,34 +104839,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + inv-status -

unique identifier of probe

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- cos + prov-status -

unique identifier of probe

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- 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 + pnf-name -

unique identifier of probe

+

unique name of Physical Network Function.

 path @@ -101479,10 +104981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + interface-name -

unique identifier of probe

+

Name that identifies the physical interface

 path @@ -101524,23 +105026,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing p-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

delete an existing class-of-service

+

update an existing p-interface

application/json application/xml

+
+
+

p-interface object that needs to be created or updated.

+

+
+
+
+
+ /p-interface +
+
+
@@ -101556,42 +105070,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- 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 + pnf-name -

unique identifier of probe

+

unique name of Physical Network Function.

 path @@ -101604,10 +105086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + interface-name -

unique identifier of probe

+

Name that identifies the physical interface

 path @@ -101618,22 +105100,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -101665,35 +105131,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing p-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

delete an existing p-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -101709,26 +105163,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - +
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
- routing-instance-id + pnf-name -

Unique id of routing instance

+

unique name of Physical Network Function.

 path @@ -101741,10 +105179,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + interface-name -

unique identifier of probe

+

Name that identifies the physical interface

 path @@ -101757,12 +105195,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + resource-version -

unique identifier of probe

+

resource-version for concurrency

pathquery string @@ -101802,24 +105240,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns l-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -101834,10 +105267,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -101905,6 +105336,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -101927,36 +105381,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

returns l-interface

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -101850,10 +105283,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the physical interface

 path @@ -101866,34 +105299,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + inv-status -

unique identifier of probe

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- cos + prov-status -

unique identifier of probe

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
@@ -101971,10 +105408,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- site-pair-set-id + pnf-name -

Unique id of site pair set.

+

unique name of Physical Network Function.

 path @@ -101987,10 +105424,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + interface-name -

Unique id of routing instance

+

Name that identifies the physical interface

 path @@ -102003,10 +105440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + interface-name -

unique identifier of probe

+

Name given to the interface

 path @@ -102017,160 +105454,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 + inv-status -

Unique id of site pair set.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- routing-instance-id + prov-status -

Unique id of routing instance

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- site-pair-id + interface-id -

unique identifier of probe

+

ID of interface

pathquery + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query 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

@@ -102193,7 +105555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vces + /l-interface
@@ -102221,19 +105583,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vce
-

GET /network/vces/vce/{vnf-id}

+
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
-

returns vce

+

create or update an existing l-interface

+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /l-interface +
+
+
+
@@ -102248,10 +105627,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -102391,29 +105682,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vce -
-
-
- -
default @@ -102436,17 +105704,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vce
-

PUT /network/vces/vce/{vnf-id}

+
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
-

create or update an existing vce

+

update an existing l-interface

@@ -102455,13 +105723,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vce object that needs to be created or updated

+

l-interface object that needs to be created or updated.

- /vce + /l-interface
@@ -102480,10 +105748,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -102264,122 +105643,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- 		query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name that identifies the physical interface

querypath string +
- vpe-id + interface-name -

Unique ID of VPE connected to this VCE.

+

Name given to the interface

querypath string +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

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 @@ -102525,17 +105825,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vce
-

DELETE /network/vces/vce/{vnf-id}

+
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 vce

+

delete an existing l-interface

@@ -102557,10 +105857,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

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 @@ -102618,17 +105950,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlements
-

GET /network/vces/vce/{vnf-id}/entitlements

+
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 entitlements

+

returns l3-interface-ipv4-address-list

@@ -102645,10 +105977,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -102661,25 +105993,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name that identifies the physical interface

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

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 @@ -102691,10 +106056,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + prov-status -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -102706,10 +106071,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + interface-id -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

ID of interface

 query @@ -102721,10 +106086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + macaddr -

Regional way of organizing pservers, source of truth should define values

+

MAC address for the interface

 query @@ -102736,10 +106101,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name of the network

 query @@ -102751,10 +106116,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vlan-id-inner -

Heat stack id corresponding to this instance, managed by MSO

+

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

 query @@ -102766,10 +106146,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + neutron-subnet-id -

Unique ID of VPE connected to this VCE.

+

Neutron id of subnet that address belongs to

 query @@ -102805,7 +106185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlements + /l3-interface-ipv4-address-list
@@ -102833,19 +106213,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlement
-

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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
-

returns entitlement

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -102860,10 +106257,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -103035,29 +106328,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /entitlement -
-
-
- -
default @@ -103080,17 +106350,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing entitlement
-

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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
-

create or update an existing entitlement

+

update an existing l3-interface-ipv4-address-list

@@ -103099,13 +106369,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /entitlement + /l3-interface-ipv4-address-list
@@ -103124,10 +106394,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -102876,10 +106273,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -102892,10 +106289,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

 path @@ -102908,122 +106305,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- 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 + l3-interface-ipv4-address -

Unique ID of VPE connected to this VCE.

+

IP address

querypath string +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -103140,10 +106410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -103156,10 +106426,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -103201,17 +106487,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing entitlement
-

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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 entitlement

+

delete an existing l3-interface-ipv4-address-list

@@ -103233,10 +106519,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -103249,10 +106535,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -103265,10 +106551,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -103326,11 +106628,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

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
@@ -103345,7 +106647,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -103370,10 +106672,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -103386,10 +106688,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -103402,10 +106704,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -103447,11 +106765,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/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
@@ -103479,10 +106797,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -103495,10 +106813,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Name that identifies the physical interface

 path @@ -103511,10 +106829,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of an entitlement resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -103556,17 +106890,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns licenses
-

GET /network/vces/vce/{vnf-id}/licenses

+
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 licenses

+

returns l3-interface-ipv6-address-list

@@ -103583,10 +106917,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -103599,25 +106933,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name that identifies the physical interface

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

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 @@ -103629,10 +106996,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + prov-status -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -103644,10 +107011,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + interface-id -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

ID of interface

 query @@ -103659,10 +107026,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + macaddr -

Regional way of organizing pservers, source of truth should define values

+

MAC address for the interface

 query @@ -103674,10 +107041,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name of the network

 query @@ -103689,10 +107056,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vlan-id-inner -

Heat stack id corresponding to this instance, managed by MSO

+

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

 query @@ -103704,10 +107086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + neutron-subnet-id -

Unique ID of VPE connected to this VCE.

+

Neutron id of subnet that address belongs to

 query @@ -103743,7 +107125,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /licenses + /l3-interface-ipv6-address-list
@@ -103771,53 +107153,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns license
-

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
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
-

returns license

+

create or update an existing l3-interface-ipv6-address-list

-
- - - - - - - - - - - - - - - - - - +
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
+ + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -103973,29 +107268,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /license -
-
-
- -
default @@ -104018,17 +107290,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing license
-

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
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
-

create or update an existing license

+

update an existing l3-interface-ipv6-address-list

@@ -104037,13 +107309,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /license + /l3-interface-ipv6-address-list
@@ -104062,10 +107334,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
- group-uuid + pnf-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

unique name of Physical Network Function.

 path @@ -103830,10 +107213,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name that identifies the physical interface

 path @@ -103846,122 +107229,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 - -

Alternate name of VNF.

- 		query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- 		query - string - - -
- service-id - -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

- 		query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- heat-stack-id + interface-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name given to the interface

querypath string +
- vpe-id + l3-interface-ipv6-address -

Unique ID of VPE connected to this VCE.

+

IP address

querypath string +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -104078,10 +107350,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the physical interface

 path @@ -104094,10 +107366,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -104139,17 +107427,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing license
-

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
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 license

+

delete an existing l3-interface-ipv6-address-list

@@ -104171,10 +107459,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -104187,10 +107475,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the physical interface

 path @@ -104203,10 +107491,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -104264,11 +107568,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

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
@@ -104283,7 +107587,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -104308,10 +107612,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -104324,10 +107628,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the physical interface

 path @@ -104340,10 +107644,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -104385,11 +107705,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/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
@@ -104417,10 +107737,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -104433,10 +107753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-name -

Unique ID for the license group the resource belongs to, should be uuid.

+

Name that identifies the physical interface

 path @@ -104449,10 +107769,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + interface-name -

Unique ID of a license resource.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -104494,19 +107830,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns port-groups
-

GET /network/vces/vce/{vnf-id}/port-groups

+
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
-

returns port-groups

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -104521,10 +107874,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -104537,70 +107890,255 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name that identifies the physical interface

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name given to the interface

querypath 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 +

+
+
+ + + + + + + + + + + - + - + + + + + + +
- vnf-type + pnf-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

unique name of Physical Network Function.

querypath string +
- service-id + interface-name -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

Name that identifies the physical interface

querypath string +
- regional-resource-zone + interface-name -

Regional way of organizing pservers, source of truth should define values

+

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 @@ -104627,10 +108165,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + interface-id -

Heat stack id corresponding to this instance, managed by MSO

+

ID of interface

 query @@ -104642,10 +108180,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + macaddr -

Unique ID of VPE connected to this VCE.

+

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

 query @@ -104681,7 +108234,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /port-groups + /sriov-vfs
@@ -104709,17 +108262,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns port-group
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+
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 port-group

+

returns sriov-vf

@@ -104736,10 +108289,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -104752,10 +108305,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -104768,40 +108321,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + pci-id -

Alternate name of VNF.

+

PCI ID used to identify the sriov-vf

querypath string +
- vnf-type + inv-status -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -104813,10 +108368,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + prov-status -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -104828,10 +108383,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + interface-id -

Regional way of organizing pservers, source of truth should define values

+

ID of interface

 query @@ -104843,10 +108398,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + macaddr -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

MAC address for the interface

 query @@ -104858,10 +108413,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + network-name -

Heat stack id corresponding to this instance, managed by MSO

+

Name of the network

 query @@ -104873,10 +108428,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + vf-vlan-filter -

Unique ID of VPE connected to this VCE.

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query @@ -104888,10 +108443,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- port-group-id + vf-mac-filter -

Unique ID for port group in vmware

+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query @@ -104903,14 +108458,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- switch-name + vf-vlan-strip -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query - string + boolean @@ -104918,10 +108473,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + neutron-network-id -

Heat stack id corresponding to this instance, managed by MSO

+

Neutron network id of the interface

 query @@ -104957,7 +108512,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /port-group + /sriov-vf
@@ -104985,17 +108540,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing port-group
-

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+
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 port-group

+

create or update an existing sriov-vf

@@ -105004,13 +108559,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

port-group object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /port-group + /sriov-vf
@@ -105029,10 +108584,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -105045,10 +108600,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

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 @@ -105090,23 +108677,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing port-group
-

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+
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
-

delete an existing port-group

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -105122,10 +108721,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -105138,10 +108737,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -105154,12 +108753,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path string @@ -105199,19 +108814,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns cvlan-tags
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

+
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
-

returns cvlan-tags

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
@@ -105226,10 +108846,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -105242,10 +108862,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -105258,40 +108878,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + pci-id -

Alternate name of VNF.

+

PCI ID used to identify the sriov-vf

querypath string +
- vnf-type + resource-version -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

resource-version for concurrency

 query @@ -105299,126 +108921,269 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/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/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- service-id + pnf-name -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

unique name of Physical Network Function.

querypath 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 + pci-id -

Heat stack id corresponding to this instance, managed by MSO

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +

+
+
+ + + + + + + + + + + - + - + - + - + @@ -105430,29 +109195,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /cvlan-tags -
-
-
- -
default @@ -105475,17 +109217,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns cvlan-tag-entry
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

returns cvlan-tag-entry

+

returns vlans

@@ -105502,10 +109244,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + +
- vpe-id + pnf-name -

Unique ID of VPE connected to this VCE.

+

unique name of Physical Network Function.

querypath string +
- port-group-id + interface-name -

Unique ID for port group in vmware

+

Name that identifies the physical interface

querypath string +
- switch-name + interface-name -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

Name given to the interface

querypath string +
- heat-stack-id + pci-id -

Heat stack id corresponding to this instance, managed by MSO

+

PCI ID used to identify the sriov-vf

querypath string +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -105518,10 +109260,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -105534,14 +109276,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + interface-name -

See mis-na-virtualization-platform.yang

+

Name given to the interface

 path - integer + string @@ -105550,10 +109292,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + inv-status -

Name of VNF.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -105565,10 +109307,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + prov-status -

Alternate name of VNF.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -105580,10 +109322,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + interface-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

ID of interface

 query @@ -105595,10 +109337,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + macaddr -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

MAC address for the interface

 query @@ -105610,10 +109352,168 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + network-name -

Regional way of organizing pservers, source of truth should define values

+

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 @@ -105640,10 +109540,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + interface-id -

Heat stack id corresponding to this instance, managed by MSO

+

ID of interface

 query @@ -105655,10 +109555,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + macaddr -

Unique ID of VPE connected to this VCE.

+

MAC address for the interface

 query @@ -105670,10 +109570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- port-group-id + network-name -

Unique ID for port group in vmware

+

Name of the network

 query @@ -105685,14 +109585,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- switch-name + vlan-id-inner -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

Inner VLAN tag

 query - string + integer @@ -105700,10 +109600,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vpn-id -

Heat stack id corresponding to this instance, managed by MSO

+

This indicates the customers VPN ID associated with this vlan

 query @@ -105739,7 +109639,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cvlan-tag-entry + /vlan
@@ -105767,17 +109667,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 cvlan-tag-entry

+

create or update an existing vlan

@@ -105786,13 +109686,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

cvlan-tag-entry object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /cvlan-tag-entry + /vlan
@@ -105811,10 +109711,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -105827,10 +109727,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -105843,14 +109743,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + interface-name -

See mis-na-virtualization-platform.yang

+

Name given to the interface

 path - integer + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string @@ -105888,23 +109804,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

delete an existing cvlan-tag-entry

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -105920,10 +109848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -105936,10 +109864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -105952,14 +109880,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + interface-name -

See mis-na-virtualization-platform.yang

+

Name given to the interface

 path - integer + string @@ -105968,12 +109896,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath string @@ -106013,35 +109941,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing vlan

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -106057,10 +109973,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -106073,10 +109989,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -106089,21 +110005,53 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + interface-name -

See mis-na-virtualization-platform.yang

+

Name given to the interface

 path - integer + string
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -106134,24 +110082,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
returns l3-interface-ipv4-address-list
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -106166,10 +110109,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -106182,10 +110125,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

Name that identifies the physical interface

 path @@ -106198,20 +110141,202 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + interface-name -

See mis-na-virtualization-platform.yang

+

Name given to the interface

 path - integer + 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-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 + + +
@@ -106221,6 +110346,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
default @@ -106243,17 +110391,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing l3-interface-ipv4-address-list

@@ -106262,13 +110410,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

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /relationship + /l3-interface-ipv4-address-list
@@ -106287,10 +110435,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -106303,10 +110451,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

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 @@ -106348,23 +110544,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing relationship

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -106380,10 +110588,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

unique name of Physical Network Function.

 path @@ -106396,10 +110604,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-name -

Unique ID of the interface

+

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 @@ -106441,35 +110697,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -106485,10 +110729,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

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 @@ -106499,6 +110807,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -106530,23 +110854,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -106562,10 +110898,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- vnf-id + pnf-name -

Unique id of VNF. This is unique across the graph.

+

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 @@ -106607,48 +111007,125 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vnfcs
-

GET /network/vnfcs

+
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
-

returns vnfcs

+

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vnfcs -
-
-
- -
default @@ -106671,17 +111148,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vnfc
-

GET /network/vnfcs/vnfc/{vnfc-name}

+
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 vnfc

+

returns l3-interface-ipv6-address-list

@@ -106698,10 +111175,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + pnf-name -

Unique ID of vnfc.

+

unique name of Physical Network Function.

 path @@ -106714,25 +111191,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-function-code + interface-name -

function code

+

Name that identifies the physical interface

querypath string +
- vnfc-type + interface-name -

type

+

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 @@ -106747,7 +111273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

prov status of this vnfc

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -106759,10 +111285,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipaddress-v4-oam-vip + interface-id -

Oam V4 vip address of this vnfc

+

ID of interface

 query @@ -106774,13 +111300,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + macaddr +

MAC address for the interface

 query - boolean + string @@ -106788,13 +111315,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + network-name +

Name of the network

 query - boolean + string @@ -106802,10 +111330,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-notation + vlan-id-inner -

Group notation of VNFC

+

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 @@ -106841,7 +111429,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vnfc + /l3-interface-ipv6-address-list
@@ -106869,17 +111457,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vnfc
-

PUT /network/vnfcs/vnfc/{vnfc-name}

+
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 vnfc

+

create or update an existing l3-interface-ipv6-address-list

@@ -106888,13 +111476,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vnfc object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /vnfc + /l3-interface-ipv6-address-list
@@ -106913,10 +111501,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + pnf-name -

Unique ID of vnfc.

+

unique name of Physical Network Function.

 path @@ -106927,73 +111515,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing vnfc
-

DELETE /network/vnfcs/vnfc/{vnfc-name}

- Tags: - Network -
-
-
-

delete an existing vnfc

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + - -
- vnfc-name + interface-name -

Unique ID of vnfc.

+

Name that identifies the physical interface

 path @@ -107006,12 +111533,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -107051,17 +111610,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -107070,13 +111629,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

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -107095,10 +111654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + pnf-name -

Unique ID of vnfc.

+

unique name of Physical Network Function.

 path @@ -107109,73 +111668,60 @@ 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/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- vnfc-name + interface-name -

Unique ID of vnfc.

+

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 @@ -107217,83 +111763,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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}

+
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
-

returns vpls-pe

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -107308,9 +111795,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -107345,29 +111898,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpls-pe -
-
-
- -
default @@ -107390,17 +111920,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}

+
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
-

create or update an existing vpls-pe

+

see node definition for valid relationships

@@ -107409,13 +111939,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

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /vpls-pe + /relationship
@@ -107434,9 +111964,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -107323,10 +111811,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name that identifies the 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 @@ -107334,6 +111886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- equipment-name + 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 @@ -107478,17 +112073,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 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 vpls-pe

+

delete an existing relationship

@@ -107510,9 +112105,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -107525,12 +112121,60 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the physical interface

querypath + 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 @@ -107570,19 +112214,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/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
-

returns lag-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -107597,9 +112258,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -107634,29 +112329,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interfaces -
-
-
- -
default @@ -107679,19 +112351,24 @@ 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}

+
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
-

returns lag-interface

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -107612,17 +112274,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string +
@@ -107706,9 +112383,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -107789,29 +112454,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interface -
-
-
- -
default @@ -107834,17 +112476,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}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

create or update an existing lag-interface

+

see node definition for valid relationships

@@ -107853,13 +112495,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)

- /lag-interface + /relationship
@@ -107878,9 +112520,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -107724,7 +112402,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 @@ -107737,47 +112415,34 @@ 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 + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + vlan-interface -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

String that identifies the interface

querypath string +
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -107896,7 +112539,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 @@ -107938,17 +112581,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

delete an existing lag-interface

+

delete an existing relationship

@@ -107970,9 +112613,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -107988,7 +112632,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 @@ -107999,22 +112643,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -108046,19 +112674,36 @@ 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

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Tags: Network
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -108073,9 +112718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- equipment-name + pnf-name +

unique name of Physical Network Function.

 path @@ -108086,12 +112732,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - -
- interface-name + pnf-name -

Name that identifies the link aggregate interface

+

unique name of Physical Network Function.

 path @@ -108102,55 +112809,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
+
+

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

@@ -108173,7 +112876,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /route-table-references
@@ -108201,17 +112904,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 route-table-reference
+

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

returns l-interface

+

returns route-table-reference

@@ -108228,41 +112931,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 + route-table-reference-id -

Name given to the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -108275,85 +112947,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 - - -
- 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 + route-table-reference-fqdn -

Name of the network

+

FQDN entry in the route table.

 query @@ -108389,7 +112986,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /route-table-reference
@@ -108417,17 +113014,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 route-table-reference
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

create or update an existing l-interface

+

create or update an existing route-table-reference

@@ -108436,13 +113033,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

+

route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)

- /l-interface + /route-table-reference
@@ -108461,41 +113058,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 + route-table-reference-id -

Name given to the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -108537,23 +113103,35 @@ 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}

+
update an existing route-table-reference
+

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

delete an existing l-interface

+

update an existing route-table-reference

application/json application/xml

+
+
+

route-table-reference object that needs to be created or updated.

+

+
+
+
+
+ /route-table-reference +
+
+
@@ -108569,25 +113147,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name + route-table-reference-id -

Name that identifies the link aggregate interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -108598,38 +113161,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -108661,19 +113192,24 @@ 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}

+
delete an existing route-table-reference
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

delete an existing route-table-reference

+
+ +

application/json application/xml +

+
@@ -108688,57 +113224,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -108893,29 +113263,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -108938,17 +113285,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}

+
see node definition for valid relationships
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -108957,13 +113304,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

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)

- /l3-interface-ipv4-address-list + /relationship
@@ -108982,57 +113329,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 - - - -
- l3-interface-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -108751,130 +113240,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 - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

- 		query - string - - -
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -108882,6 +113251,7 @@ 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 - - - -
- l3-interface-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -109074,17 +113374,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 relationship
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing relationship

@@ -109106,57 +113406,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 - - - -
- l3-interface-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -109167,22 +113420,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -109214,120 +113451,48 @@ 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 site-pair-sets
+

GET /network/site-pair-sets

Tags: Network
-

see node definition for valid relationships

+

returns site-pair-sets

-
- -

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 - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
-

application/json application/xml

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair-sets +
+
+
+ +
default @@ -109350,24 +113515,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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns site-pair-set
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

delete an existing relationship

+

returns site-pair-set

-
- -

application/json application/xml -

-
@@ -109382,57 +113542,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 - - - -
- l3-interface-ipv4-address + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -109452,6 +113565,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair-set +
+
+
+ +
default @@ -109474,19 +113610,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing site-pair-set
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

returns l3-interface-ipv6-address-list

+

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/v10/NetworkSitePairSetsSitePairSet.json)

+

+
+
+
+
+ /site-pair-set +
+
+
+
@@ -109501,57 +113654,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 - - - -
- l3-interface-ipv6-address + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -109562,141 +113668,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- 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 - - -
@@ -109706,29 +113677,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
default @@ -109751,17 +113699,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}

+
update an existing site-pair-set
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

update an existing site-pair-set

@@ -109770,13 +113718,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

+

site-pair-set object that needs to be created or updated.

- /l3-interface-ipv6-address-list + /site-pair-set
@@ -109795,57 +113743,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 - - - -
- l3-interface-ipv6-address + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -109887,17 +113788,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 site-pair-set
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing site-pair-set

@@ -109919,57 +113820,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 - - - -
- l3-interface-ipv6-address + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -110027,11 +113881,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network
@@ -110046,7 +113900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)

@@ -110071,57 +113925,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 - - - -
- l3-interface-ipv6-address + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -110163,11 +113970,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network
@@ -110195,9 +114002,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -110208,28 +114016,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- interface-name + site-pair-set-id -

Name given to the interface

+

Unique id of site pair set.

 path @@ -110242,10 +114185,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + routing-instance-id -

IP address

+

Unique id of routing instance

 path @@ -110265,6 +114208,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /routing-instance +
+
+
+ +
default @@ -110287,17 +114253,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 routing-instance
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing routing-instance

@@ -110306,13 +114272,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

+

routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

- /relationship + /routing-instance
@@ -110331,25 +114297,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -110362,10 +114313,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -110407,23 +114358,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
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
-

delete an existing relationship

+

update an existing routing-instance

application/json application/xml

+
+
+

routing-instance object that needs to be created or updated.

+

+
+
+
+
+ /routing-instance +
+
+
@@ -110439,25 +114402,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -110470,10 +114418,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -110515,19 +114463,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
delete an existing routing-instance
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network
-

returns sriov-vfs

+

delete an existing routing-instance

+
+ +

application/json application/xml +

+
@@ -110542,25 +114495,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -110686,29 +114550,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -110731,19 +114572,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
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
-

returns sriov-vf

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

+

+
+
+
+
+ /relationship +
+
+
+
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -110573,10 +114511,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -110589,85 +114527,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 - - -
- 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 + resource-version -

Name of the network

+

resource-version for concurrency

 query @@ -110675,6 +114538,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -110758,9 +114616,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -110773,10 +114632,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the link aggregate interface

+

Unique id of routing instance

 path @@ -110787,12 +114646,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/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 +

+
+
+ + + + + + + + + + + + +
- interface-name + site-pair-set-id -

Name given to the interface

+

Unique id of site pair set.

 path @@ -110805,10 +114725,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + routing-instance-id -

PCI ID used to identify the sriov-vf

+

Unique id of routing instance

 path @@ -110819,154 +114739,92 @@ 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 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

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - + @@ -110995,7 +114853,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /site-pairs
@@ -111023,36 +114881,19 @@ 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}

+
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
-

create or update an existing sriov-vf

+

returns site-pair

-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated

-

-
-
-
-
- /sriov-vf -
-
-
-
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

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 + site-pair-set-id -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Unique id of site pair set.

querypath string +
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

- 		query - boolean - - -
- neutron-network-id + routing-instance-id -

Neutron network id of the interface

+

Unique id of routing instance

querypath string +
@@ -111067,25 +114908,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -111098,10 +114924,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -111114,10 +114940,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + site-pair-id -

PCI ID used to identify the sriov-vf

+

unique identifier of probe

 path @@ -111137,6 +114963,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair +
+
+
+ +
default @@ -111159,23 +115008,35 @@ 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}

+
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
-

delete an existing sriov-vf

+

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/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

+

+
+
+
+
+ /site-pair +
+
+
@@ -111191,25 +115052,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -111222,10 +115068,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -111238,10 +115084,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + site-pair-id -

PCI ID used to identify the sriov-vf

+

unique identifier of probe

 path @@ -111252,22 +115098,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -111299,17 +115129,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing site-pair

@@ -111318,13 +115148,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

+

site-pair object that needs to be created or updated.

- /relationship + /site-pair
@@ -111343,25 +115173,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -111374,10 +115189,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -111390,10 +115205,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + site-pair-id -

PCI ID used to identify the sriov-vf

+

unique identifier of probe

 path @@ -111435,17 +115250,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
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 relationship

+

delete an existing site-pair

@@ -111467,9 +115282,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -111482,10 +115298,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the link aggregate interface

+

Unique id of routing instance

 path @@ -111498,10 +115314,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + site-pair-id -

Name given to the interface

+

unique identifier of probe

 path @@ -111514,12 +115330,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

pathquery string @@ -111559,17 +115375,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns 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 vlans

+

returns classes-of-service

@@ -111586,9 +115402,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -111601,10 +115418,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the link aggregate interface

+

Unique id of routing instance

 path @@ -111617,10 +115434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + site-pair-id -

Name given to the interface

+

unique identifier of probe

 path @@ -111631,96 +115448,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -111747,7 +115474,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /classes-of-service
@@ -111775,17 +115502,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns 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 vlan

+

returns class-of-service

@@ -111802,9 +115529,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -111817,10 +115545,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the link aggregate interface

+

Unique id of routing instance

 path @@ -111833,10 +115561,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + site-pair-id -

Name given to the interface

+

unique identifier of probe

 path @@ -111849,10 +115577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + cos -

String that identifies the interface

+

unique identifier of probe

 path @@ -111863,126 +115591,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
@@ -112009,7 +115617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /class-of-service
@@ -112037,17 +115645,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vlan
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing 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 vlan

+

create or update an existing class-of-service

@@ -112056,13 +115664,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

- /vlan + /class-of-service
@@ -112081,9 +115689,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -112096,10 +115705,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the link aggregate interface

+

Unique id of routing instance

 path @@ -112112,10 +115721,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + site-pair-id -

Name given to the interface

+

unique identifier of probe

 path @@ -112128,10 +115737,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + cos -

String that identifies the interface

+

unique identifier of probe

 path @@ -112173,23 +115782,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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
-

delete an existing vlan

+

update an existing class-of-service

application/json application/xml

+
+
+

class-of-service object that needs to be created or updated.

+

+
+
+
+
+ /class-of-service +
+
+
@@ -112205,9 +115826,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- equipment-name + site-pair-set-id +

Unique id of site pair set.

 path @@ -112220,10 +115842,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the link aggregate interface

+

Unique id of routing instance

 path @@ -112236,10 +115858,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + site-pair-id -

Name given to the interface

+

unique identifier of probe

 path @@ -112252,10 +115874,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + cos -

String that identifies the interface

+

unique identifier of probe

 path @@ -112266,22 +115888,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -112313,19 +115919,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
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
-

returns l3-interface-ipv4-address-list

+

delete an existing class-of-service

+
+ +

application/json application/xml +

+
@@ -112340,25 +115951,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -112591,29 +116038,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -112636,17 +116060,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
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
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -112655,13 +116079,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

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

- /l3-interface-ipv4-address-list + /relationship
@@ -112680,25 +116104,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -112371,10 +115967,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -112387,10 +115983,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + site-pair-id -

String that identifies the interface

+

unique identifier of probe

 path @@ -112403,10 +115999,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + cos -

IP address

+

unique identifier of probe

 path @@ -112419,160 +116015,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 - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

- 		query - string - - -
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -112580,6 +116026,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -112711,10 +116120,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -112727,10 +116136,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + site-pair-id -

String that identifies the interface

+

unique identifier of probe

 path @@ -112743,10 +116152,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + cos -

IP address

+

unique identifier of probe

 path @@ -112788,17 +116197,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
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 l3-interface-ipv4-address-list

+

delete an existing relationship

@@ -112820,25 +116229,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the link aggregate interface

+

Unique id of site pair set.

 path @@ -112851,10 +116245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -112867,10 +116261,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + site-pair-id -

String that identifies the interface

+

unique identifier of probe

 path @@ -112883,10 +116277,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + cos -

IP address

+

unique identifier of probe

 path @@ -112897,22 +116291,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -112944,11 +116322,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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

Tags: Network
@@ -112963,7 +116341,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

@@ -112988,41 +116366,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 + site-pair-set-id -

Name given to the interface

+

Unique id of site pair set.

 path @@ -113035,10 +116382,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + routing-instance-id -

String that identifies the interface

+

Unique id of routing instance

 path @@ -113051,10 +116398,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + site-pair-id -

IP address

+

unique identifier of probe

 path @@ -113096,11 +116443,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
@@ -113128,41 +116475,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 + site-pair-set-id -

Name given to the interface

+

Unique id of site pair set.

 path @@ -113175,10 +116491,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + routing-instance-id -

String that identifies the interface

+

Unique id of routing instance

 path @@ -113191,10 +116507,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + site-pair-id -

IP address

+

unique identifier of probe

 path @@ -113236,17 +116552,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns vces
+

GET /network/vces

Tags: Network
-

returns l3-interface-ipv6-address-list

+

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

@@ -113263,73 +116643,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 - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + vnf-id -

IP address

+

Unique id of VNF. This is unique across the graph.

 path @@ -113342,25 +116659,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 + vnf-name -

ID of interface

+

Name of VNF.

 query @@ -113372,10 +116674,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + vnf-name2 -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Alternate name of VNF.

 query @@ -113387,10 +116689,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vnf-type -

ID of interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -113402,10 +116704,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + service-id -

MAC address for the interface

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query @@ -113417,10 +116719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + regional-resource-zone -

Name of the network

+

Regional way of organizing pservers, source of truth should define values

 query @@ -113432,25 +116734,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-id + prov-status -

This indicates the customers VPN ID associated with this vlan

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -113462,25 +116749,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 + heat-stack-id -

Neutron network id of the interface that address belongs to

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -113492,10 +116764,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + vpe-id -

Neutron id of subnet that address belongs to

+

Unique ID of VPE connected to this VCE.

 query @@ -113531,7 +116803,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /vce
@@ -113559,17 +116831,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing vce
+

PUT /network/vces/vce/{vnf-id}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing vce

@@ -113578,13 +116850,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

+

vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)

- /l3-interface-ipv6-address-list + /vce
@@ -113603,25 +116875,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the link aggregate interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -113632,12 +116889,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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 +
+
+
+
+
+ + + + + + + + + + + + +
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -113648,12 +116978,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vce
+

DELETE /network/vces/vce/{vnf-id}

+ Tags: + Network +
+
+
+

delete an existing vce

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + + + + + + + +
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -113666,12 +117057,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -113711,24 +117102,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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 entitlements
+

GET /network/vces/vce/{vnf-id}/entitlements

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

returns entitlements

-
- -

application/json application/xml -

-
@@ -113743,9 +117129,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - + + + + + + + + + + + + + + + + + + + + + + @@ -113845,6 +117272,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
default @@ -113867,36 +117317,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns entitlement
+

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

see node definition for valid relationships

+

returns entitlement

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -113758,74 +117145,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vnf-name -

Name that identifies the link aggregate interface

+

Name of VNF.

pathquery string -
- interface-name + vnf-name2 -

Name given to the interface

+

Alternate name of VNF.

pathquery string -
- vlan-interface + vnf-type -

String that identifies the interface

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery string -
- l3-interface-ipv6-address + service-id -

IP address

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

pathquery string -
- resource-version + regional-resource-zone -

resource-version for concurrency

+

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 @@ -113833,7 +117261,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -113911,9 +117344,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -113997,6 +117519,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlement +
+
+
+ +
default @@ -114019,23 +117564,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing entitlement
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing relationship

+

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/v10/NetworkVcesVceEntitlementsEntitlement.json)

+

+
+
+
+
+ /entitlement +
+
+
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -113926,10 +117360,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the link aggregate interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -113942,10 +117376,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-uuid -

Name given to the interface

+

Unique ID of an entitlement resource.

 path @@ -113958,34 +117392,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vnf-name -

String that identifies the interface

+

Name of VNF.

pathquery string -
- l3-interface-ipv6-address + vnf-name2 -

IP address

+

Alternate name of VNF.

pathquery + 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 -
@@ -114051,41 +117608,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 + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -114098,10 +117624,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + group-uuid -

String that identifies the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -114114,10 +117640,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

 path @@ -114159,17 +117685,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
update an existing entitlement
+

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

see node definition for valid relationships

+

update an existing entitlement

@@ -114178,13 +117704,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

+

entitlement object that needs to be created or updated.

- /relationship + /entitlement
@@ -114203,25 +117729,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the link aggregate interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -114234,10 +117745,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -114250,10 +117761,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-uuid -

String that identifies the interface

+

Unique ID of an entitlement resource.

 path @@ -114295,17 +117806,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
delete an existing entitlement
+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing relationship

+

delete an existing entitlement

@@ -114327,9 +117838,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -114342,10 +117854,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the link aggregate interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -114358,10 +117870,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-uuid -

Name given to the interface

+

Unique ID of an entitlement resource.

 path @@ -114374,12 +117886,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-version -

String that identifies the interface

+

resource-version for concurrency

pathquery string @@ -114419,11 +117931,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -114438,7 +117950,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)

@@ -114463,9 +117975,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -114478,10 +117991,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the link aggregate interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

 path @@ -114523,11 +118052,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -114555,9 +118084,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -114570,10 +118100,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the link aggregate interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

 path @@ -114615,17 +118161,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

+
returns licenses
+

GET /network/vces/vce/{vnf-id}/licenses

Tags: Network
-

returns p-interfaces

+

returns licenses

@@ -114642,9 +118188,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -114655,12 +118202,117 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vnf-name + +

Name of VNF.

+ 		query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+ 		query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ service-id + +

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+ 		query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+ 		query + string + + +
prov-status -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

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 @@ -114696,7 +118348,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interfaces + /licenses
@@ -114724,17 +118376,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+
returns license
+

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

returns p-interface

+

returns license

@@ -114751,9 +118403,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -114766,10 +118419,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -114782,10 +118435,86 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + resource-uuid -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

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 @@ -114810,6 +118539,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+ 		query + string + + +
@@ -114836,7 +118595,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interface + /license
@@ -114864,17 +118623,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing p-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+
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 p-interface

+

create or update an existing license

@@ -114883,13 +118642,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated

+

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)

- /p-interface + /license
@@ -114908,9 +118667,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -114923,10 +118683,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the license group the resource belongs to, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

 path @@ -114968,23 +118744,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing p-interface
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+
update an existing license
+

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing p-interface

+

update an existing license

application/json application/xml

+
+
+

license object that needs to be created or updated.

+

+
+
+
+
+ /license +
+
+
@@ -115000,9 +118788,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + - - - - - - - - - - - - - -
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -115015,10 +118804,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -115031,12 +118820,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + resource-uuid -

resource-version for concurrency

+

Unique ID of a license resource.

querypath string @@ -115076,19 +118865,24 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces

+
delete an existing license
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

returns l-interfaces

+

delete an existing license

+
+ +

application/json application/xml +

+
@@ -115103,9 +118897,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -115171,29 +118968,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -115216,19 +118990,36 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

returns l-interface

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)

+

+
+
+
+
+ /relationship +
+
+
+
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -115118,10 +118913,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -115134,25 +118929,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + resource-uuid -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Unique ID of a license resource.

querypath string +
- prov-status + resource-version -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

resource-version for concurrency

 query @@ -115160,6 +118956,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -115243,9 +119034,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -115258,10 +119050,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -115274,10 +119066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-uuid -

Name given to the interface

+

Unique ID of a license resource.

 path @@ -115288,81 +119080,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -115372,29 +119089,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -115417,35 +119111,23 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

create or update an existing l-interface

+

delete an existing relationship

application/json application/xml

-
-
-

l-interface object that needs to be created or updated

-

-
-
-
-
- /l-interface -
-
-
@@ -115461,9 +119143,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -115476,10 +119159,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name that identifies the physical interface

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -115492,10 +119175,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-uuid -

Name given to the interface

+

Unique ID of a license resource.

 path @@ -115537,24 +119220,19 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns port-groups
+

GET /network/vces/vce/{vnf-id}/port-groups

Tags: Network
-

delete an existing l-interface

+

returns port-groups

-
- -

application/json application/xml -

-
@@ -115569,9 +119247,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -115584,42 +119263,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vnf-name -

Name that identifies the physical interface

+

Name of VNF.

pathquery string -
- interface-name + vnf-name2 -

Name given to the interface

+

Alternate name of VNF.

pathquery string -
- resource-version + vnf-type -

resource-version for concurrency

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -115627,23 +119304,120 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
+
+ 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.

@@ -115661,17 +119435,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns port-group
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns port-group

@@ -115688,9 +119462,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -115703,10 +119478,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name that identifies the physical interface

+

Unique ID of the interface

 path @@ -115719,42 +119494,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vnf-name -

Name given to the interface

+

Name of VNF.

pathquery string -
- l3-interface-ipv4-address + vnf-name2 -

IP address

+

Alternate name of VNF.

pathquery string -
- prov-status + vnf-type -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -115766,10 +119539,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + service-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query @@ -115781,10 +119554,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + regional-resource-zone -

ID of interface

+

Regional way of organizing pservers, source of truth should define values

 query @@ -115796,10 +119569,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + prov-status -

MAC address for the interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -115811,10 +119584,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + heat-stack-id -

Name of the network

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -115826,14 +119599,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vpe-id -

Inner VLAN tag

+

Unique ID of VPE connected to this VCE.

 query - integer + string @@ -115841,10 +119614,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + port-group-id -

Neutron network id of the interface that address belongs to

+

Unique ID for port group in vmware

 query @@ -115856,10 +119629,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + switch-name -

Neutron id of subnet that address belongs to

+

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 @@ -115895,7 +119683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /port-group
@@ -115923,17 +119711,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}/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 port-group
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing port-group

@@ -115942,13 +119730,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

+

port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)

- /l3-interface-ipv4-address-list + /port-group
@@ -115967,41 +119755,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 physical interface

- 		path - string - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -116014,10 +119771,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-id -

IP address

+

Unique ID of the interface

 path @@ -116059,23 +119816,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
update an existing port-group
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

update an existing port-group

application/json application/xml

+
+
+

port-group object that needs to be created or updated.

+

+
+
+
+
+ /port-group +
+
+
@@ -116091,41 +119860,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 physical interface

- 		path - string - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -116138,10 +119876,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-id -

IP address

+

Unique ID of the interface

 path @@ -116152,22 +119890,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -116199,35 +119921,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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 port-group
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

see node definition for valid relationships

+

delete an existing port-group

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -116243,25 +119953,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - +
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -116274,10 +119969,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name given to the interface

+

Unique ID of the interface

 path @@ -116290,12 +119985,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -116335,24 +120030,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
returns cvlan-tags
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

Tags: Network
-

delete an existing relationship

+

returns cvlan-tags

-
- -

application/json application/xml -

-
@@ -116367,9 +120057,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -116437,6 +120261,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /cvlan-tags +
+
+
+ +
default @@ -116459,17 +120306,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
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 l3-interface-ipv6-address-list

+

returns cvlan-tag-entry

@@ -116486,9 +120333,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- + + + + + + + + + + + + + + + - - - - - - -
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -116382,10 +120073,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name that identifies the physical interface

+

Unique ID of the interface

 path @@ -116398,34 +120089,167 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vnf-name -

Name given to the interface

+

Name of VNF.

pathquery string -
- l3-interface-ipv4-address + vnf-name2 -

IP address

+

Alternate name of VNF.

pathquery + 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 -
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -116501,10 +120349,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name that identifies the physical interface

+

Unique ID of the interface

 path @@ -116517,14 +120365,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cvlan-tag -

Name given to the interface

+

See mis-na-virtualization-platform.yang

 path - string + integer @@ -116533,26 +120381,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vnf-name -

IP address

+

Name of VNF.

pathquery string -
- prov-status + vnf-name2 -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Alternate name of VNF.

 query @@ -116564,10 +120411,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vnf-type -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -116579,10 +120426,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + service-id -

ID of interface

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query @@ -116594,10 +120441,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + regional-resource-zone -

MAC address for the interface

+

Regional way of organizing pservers, source of truth should define values

 query @@ -116609,10 +120456,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + prov-status -

Name of the network

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -116624,14 +120471,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + heat-stack-id -

Inner VLAN tag

+

Heat stack id corresponding to this instance, managed by MSO

 query - integer + string @@ -116639,10 +120486,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + vpe-id -

Neutron network id of the interface that address belongs to

+

Unique ID of VPE connected to this VCE.

 query @@ -116654,10 +120501,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + port-group-id -

Neutron id of subnet that address belongs to

+

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 @@ -116693,7 +120570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /cvlan-tag-entry
@@ -116721,17 +120598,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}/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 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 l3-interface-ipv6-address-list

+

create or update an existing cvlan-tag-entry

@@ -116740,13 +120617,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

+

cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

- /l3-interface-ipv6-address-list + /cvlan-tag-entry
@@ -116765,25 +120642,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -116796,10 +120658,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name given to the interface

+

Unique ID of the interface

 path @@ -116812,14 +120674,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + cvlan-tag -

IP address

+

See mis-na-virtualization-platform.yang

 path - string + integer @@ -116857,23 +120719,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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 cvlan-tag-entry
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

update an existing cvlan-tag-entry

application/json application/xml

+
+
+

cvlan-tag-entry object that needs to be created or updated.

+

+
+
+
+
+ /cvlan-tag-entry +
+
+
@@ -116889,9 +120763,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -116904,10 +120779,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name that identifies the physical interface

+

Unique ID of the interface

 path @@ -116920,10 +120795,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cvlan-tag -

Name given to the interface

+

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 @@ -116936,10 +120888,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-id -

IP address

+

Unique ID of the interface

 path @@ -116950,6 +120902,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+ 		path + integer + + + +
resource-version @@ -116997,11 +120965,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

Tags: Network
@@ -117016,7 +120984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

@@ -117041,25 +121009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -117072,10 +121025,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name given to the interface

+

Unique ID of the interface

 path @@ -117088,14 +121041,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + cvlan-tag -

IP address

+

See mis-na-virtualization-platform.yang

 path - string + integer @@ -117133,11 +121086,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/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 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

Tags: Network
@@ -117165,25 +121118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -117196,10 +121134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name given to the interface

+

Unique ID of the interface

 path @@ -117212,14 +121150,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + cvlan-tag -

IP address

+

See mis-na-virtualization-platform.yang

 path - string + integer @@ -117257,11 +121195,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network
@@ -117276,7 +121214,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)

@@ -117301,25 +121239,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name + vnf-id -

Name that identifies the physical interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -117332,10 +121255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name given to the interface

+

Unique ID of the interface

 path @@ -117377,11 +121300,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network
@@ -117409,9 +121332,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -117424,10 +121348,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-id -

Name that identifies the physical interface

+

Unique ID of the interface

 path @@ -117438,12 +121362,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /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/v10/NetworkVcesVce.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -117485,19 +121482,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

Tags: Network
-

returns sriov-vfs

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -117512,9 +121514,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name + vnf-id +

Unique id of VNF. This is unique across the graph.

 path @@ -117525,117 +121528,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- 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 +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnfcs
+

GET /network/vnfcs

+ Tags: + Network +
+
+
+

returns vnfcs

+ +
+

application/json application/xml

@@ -117658,7 +121595,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /vnfcs
@@ -117686,17 +121623,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
returns vnfc
+

GET /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

returns sriov-vf

+

returns vnfc

@@ -117713,57 +121650,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 physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + vnfc-name -

PCI ID used to identify the sriov-vf

+

Unique ID of vnfc.

 path @@ -117776,40 +121666,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 - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- interface-id + vnfc-function-code -

ID of interface

+

function code

 query @@ -117821,10 +121681,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vnfc-type -

MAC address for the interface

+

type

 query @@ -117836,10 +121696,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + prov-status -

Name of the network

+

prov status of this vnfc

 query @@ -117851,10 +121711,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + ipaddress-v4-oam-vip -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Oam V4 vip address of this vnfc

 query @@ -117866,14 +121726,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + in-maint -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query - string + boolean @@ -117881,10 +121740,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + is-closed-loop-disabled -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query @@ -117896,10 +121754,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + group-notation -

Neutron network id of the interface

+

Group notation of VNFC

 query @@ -117935,7 +121793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /vnfc
@@ -117963,17 +121821,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing vnfc
+

PUT /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

create or update an existing sriov-vf

+

create or update an existing vnfc

@@ -117982,13 +121840,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

+

vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)

- /sriov-vf + /vnfc
@@ -118007,57 +121865,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 physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + vnfc-name -

PCI ID used to identify the sriov-vf

+

Unique ID of vnfc.

 path @@ -118099,23 +121910,35 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
update an existing vnfc
+

PATCH /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

delete an existing sriov-vf

+

update an existing vnfc

application/json application/xml

+
+
+

vnfc object that needs to be created or updated.

+

+
+
+
+
+ /vnfc +
+
+
@@ -118131,41 +121954,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 physical interface

- 		path - string - - - -
- interface-name + vnfc-name -

Name given to the interface

+

Unique ID of vnfc.

 path @@ -118176,12 +121968,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vnfc
+

DELETE /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

delete an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pci-id + vnfc-name -

PCI ID used to identify the sriov-vf

+

Unique ID of vnfc.

 path @@ -118239,11 +122092,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network
@@ -118258,7 +122111,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)

@@ -118283,57 +122136,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 physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + vnfc-name -

PCI ID used to identify the sriov-vf

+

Unique ID of vnfc.

 path @@ -118375,11 +122181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network
@@ -118407,57 +122213,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 physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + vnfc-name -

PCI ID used to identify the sriov-vf

+

Unique ID of vnfc.

 path @@ -118499,156 +122258,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns vpls-pes
+

GET /network/vpls-pes

Tags: Network
-

returns vlans

+

returns vpls-pes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 @@ -118672,7 +122294,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /vlans + /vpls-pes
@@ -118700,17 +122322,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns vpls-pe
+

GET /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

returns vlan

+

returns vpls-pe

@@ -118740,54 +122362,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
prov-status @@ -118803,96 +122377,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - 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 - - -
@@ -118919,7 +122403,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /vpls-pe
@@ -118947,17 +122431,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vlan
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
create or update an existing vpls-pe
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

create or update an existing vlan

+

create or update an existing vpls-pe

@@ -118966,13 +122450,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)

- /vlan + /vpls-pe
@@ -119004,54 +122488,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -119083,23 +122519,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vlan
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing vpls-pe
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

delete an existing vlan

+

update an existing vpls-pe

application/json application/xml

+
+
+

vpls-pe object that needs to be created or updated.

+

+
+
+
+
+ /vpls-pe +
+
+
@@ -119128,70 +122576,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- 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 - - - -
@@ -119223,19 +122607,24 @@ 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}/p-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 vpls-pe
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

returns l3-interface-ipv4-address-list

+

delete an existing vpls-pe

+
+ +

application/json application/xml +

+
@@ -119265,12 +122654,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - -
- interface-name + resource-version -

Name that identifies the physical interface

+

resource-version for concurrency

pathquery string @@ -119279,17 +122668,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - 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 + @@ -119297,10 +122741,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + 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 -

String that identifies the interface

 path @@ -119313,10 +122850,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 that identifies the link aggregate interface

 path @@ -119344,10 +122881,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of interface

 query @@ -119359,10 +122896,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + interface-role -

ID of interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -119372,102 +122909,335 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+
+ /lag-interface +
+
+
+
+
+ + + + + + + + + + + - + - + + +
- macaddr + equipment-name -

MAC address for the interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the link aggregate interface

querypath 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 +
+
+
+
+
+ + + + + + + + + + + - + - + + +
- vlan-id-inner + equipment-name -

Inner VLAN tag

querypath - integer + string +
- vpn-id + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the link aggregate interface

querypath 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 +

+
+
+ + + + + + + + + + + - + - + @@ -119486,29 +123257,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -119531,36 +123279,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-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 l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns l-interfaces

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
- vlan-id-inner + equipment-name -

Inner VLAN tag

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name that identifies the link aggregate interface

querypath string +
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -119475,6 +123245,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -119593,7 +123324,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + - + @@ -119661,6 +123389,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -119683,24 +123434,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /network/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 l-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

returns l-interface

-
- -

application/json application/xml -

-
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -119606,50 +123337,47 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + prov-status -

Name given to the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- vlan-interface + interface-id -

String that identifies the interface

+

ID of interface

pathquery string -
- l3-interface-ipv4-address + interface-role -

IP address

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

pathquery string -
@@ -119733,7 +123479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + + + + + + + + + + + + + + + + + + + + + + @@ -119817,6 +123605,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
default @@ -119839,17 +123650,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing l-interface

@@ -119858,13 +123669,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

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /relationship + /l-interface
@@ -119901,7 +123712,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -119762,42 +123508,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + prov-status -

String that identifies the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- l3-interface-ipv4-address + interface-id -

IP address

+

ID of interface

pathquery string -
- resource-version + interface-role -

resource-version for concurrency

+

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 @@ -119805,7 +123594,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -119928,12 +123739,100 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l-interface
+

PATCH /network/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 + + + +
- vlan-interface + interface-name -

String that identifies the interface

+

Name that identifies the link aggregate interface

 path @@ -119946,10 +123845,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 @@ -119991,17 +123890,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+
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 relationship

+

delete an existing l-interface

@@ -120041,7 +123940,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -120070,28 +123969,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -120131,17 +124014,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}/p-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-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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -120176,7 +124059,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -120205,10 +124088,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -120221,26 +124104,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + prov-status -

IP address

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- prov-status + interface-id -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

ID of interface

 query @@ -120252,10 +124134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-role -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -120325,36 +124207,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
neutron-network-id @@ -120411,7 +124263,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -120439,17 +124291,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/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-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -120458,13 +124310,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -120501,7 +124353,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -120530,23 +124382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -120591,23 +124427,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/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-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -120641,7 +124489,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -120670,23 +124518,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -120700,22 +124532,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -120747,35 +124563,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-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 l3-interface-ipv4-address-list
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -120809,7 +124613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -120838,10 +124642,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -120854,12 +124658,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -120899,23 +124703,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/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
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -120949,7 +124765,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -120978,23 +124794,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -121039,35 +124839,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -121101,7 +124889,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -121130,10 +124918,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -121175,24 +124963,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns l3-interface-ipv6-address-list
+

GET /network/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 relationship

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
@@ -121225,7 +125008,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -121254,10 +125037,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -121268,6 +125051,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ 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 + + +
@@ -121277,6 +125195,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
default @@ -121299,17 +125240,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing l3-interface-ipv6-address-list

@@ -121318,13 +125259,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

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /relationship + /l3-interface-ipv6-address-list
@@ -121361,7 +125302,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -121372,72 +125313,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/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 + interface-name +

Name given to the interface

 path @@ -121450,10 +125331,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv6-address -

Name that identifies the physical interface

+

IP address

 path @@ -121495,17 +125376,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}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -121514,13 +125395,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

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -121552,6 +125433,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -121583,17 +125512,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}/relationship-list/relationship

+
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 relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -121628,132 +125557,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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

- -
-
- - - - - - - - - - - - + + + + + + + + @@ -121803,29 +125630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpn-binding -
-
-
- -
default @@ -121848,17 +125652,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vpn-binding
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

create or update an existing vpn-binding

+

see node definition for valid relationships

@@ -121867,13 +125671,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vpn-binding object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /vpn-binding + /relationship
@@ -121892,10 +125696,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vpn-id + interface-name -

VPN ID, globally unique within A&AI

+

Name that identifies the link aggregate interface

 path @@ -121766,25 +125575,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-name + interface-name -

VPN Name

+

Name given to the interface

querypath string +
- vpn-type + l3-interface-ipv6-address -

Type of the vpn, should be taken from enumerated/valid values

+

IP address

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

 query @@ -121792,6 +125618,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

+ 		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 @@ -121937,17 +125788,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vpn-binding
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing vpn-binding

+

delete an existing relationship

@@ -121969,10 +125820,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -121985,12 +125835,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -122030,11 +125912,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/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
@@ -122049,7 +125931,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -122074,10 +125956,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -122119,11 +126032,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+

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
@@ -122151,10 +126064,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -122196,17 +126140,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns route-targets
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

+
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 route-targets

+

returns sriov-vfs

@@ -122223,10 +126167,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -122239,10 +126182,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-name + interface-name -

VPN 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 @@ -122254,10 +126229,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-type + interface-id -

Type of the vpn, should be taken from enumerated/valid values

+

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 @@ -122293,7 +126328,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-targets + /sriov-vfs
@@ -122321,17 +126356,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns route-target
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+
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 route-target

+

returns sriov-vf

@@ -122348,10 +126383,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -122364,10 +126398,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- global-route-target + interface-name -

Number used to identify an RT, globally unique in the network

+

Name that identifies the link aggregate interface

 path @@ -122380,10 +126414,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-target-role + interface-name -

Role assigned to this route target

+

Name given to the interface

 path @@ -122396,10 +126430,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-name + pci-id -

VPN Name

+

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 @@ -122411,10 +126461,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-type + interface-id -

Type of the vpn, should be taken from enumerated/valid values

+

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 @@ -122450,7 +126620,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-target + /sriov-vf
@@ -122478,17 +126648,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 route-target

+

create or update an existing sriov-vf

@@ -122497,13 +126667,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

route-target object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /route-target + /sriov-vf
@@ -122522,10 +126692,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -122538,10 +126707,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- global-route-target + interface-name -

Number used to identify an RT, globally unique in the network

+

Name that identifies the link aggregate interface

 path @@ -122554,10 +126723,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-target-role + interface-name -

Role assigned to this route target

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -122599,30 +126784,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing route-target
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+
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
-

delete an existing route-target

+

update an existing sriov-vf

application/json application/xml

-
-
- - - - - +
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+ +
+
+ + + + @@ -122631,10 +126828,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -122647,10 +126843,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- global-route-target + interface-name -

Number used to identify an RT, globally unique in the network

+

Name that identifies the link aggregate interface

 path @@ -122663,10 +126859,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-target-role + interface-name -

Role assigned to this route target

+

Name given to the interface

 path @@ -122679,12 +126875,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -122724,35 +126920,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

+
delete an existing 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
-

see node definition for valid relationships

+

delete an existing sriov-vf

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -122768,10 +126952,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -122784,10 +126967,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- global-route-target + interface-name -

Number used to identify an RT, globally unique in the network

+

Name that identifies the link aggregate interface

 path @@ -122800,10 +126983,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-target-role + interface-name -

Role assigned to this route target

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -122814,6 +127013,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -122845,23 +127060,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

+
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
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -122877,10 +127104,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- vpn-id + equipment-name -

VPN ID, globally unique within A&AI

 path @@ -122893,10 +127119,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- global-route-target + interface-name -

Number used to identify an RT, globally unique in the network

+

Name that identifies the link aggregate interface

 path @@ -122909,10 +127135,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-target-role + interface-name -

Role assigned to this route target

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -122954,83 +127196,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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}

+
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
-

returns zone

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -123045,10 +127228,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- zone-id + equipment-name -

Code assigned by AIC to the zone

 path @@ -123061,136 +127243,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- design-type + interface-name -

Design of zone [Medium/Large?]

+

Name that identifies the link aggregate interface

querypath string +
- zone-context + interface-name -

Context of zone [production/test]

+

Name given to the interface

querypath 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

-

-
-
-
-
- /zone -
-
-
-
-
- - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- zone-id + pci-id -

Code assigned by AIC to the zone

+

PCI ID used to identify the sriov-vf

 path @@ -123232,24 +127320,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing zone
-

DELETE /network/zones/zone/{zone-id}

+
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
-

delete an existing zone

+

returns vlans

-
- -

application/json application/xml -

-
@@ -123264,10 +127347,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- zone-id + equipment-name -

Code assigned by AIC to the zone

 path @@ -123280,12 +127362,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath string @@ -123294,85 +127376,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /network/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

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - -
- zone-id + interface-name -

Code assigned by AIC to the zone

+

Name given to the interface

 path @@ -123383,128 +127392,100 @@ 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/zones/zone/{zone-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- zone-id + prov-status -

Code assigned by AIC to the zone

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery + 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns models
-

GET /service-design-and-creation/models

- Tags: - ServiceDesignAndCreation -
-
-
-

returns models

- -
-

application/json application/xml

@@ -123527,7 +127508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /models + /vlans
@@ -123555,17 +127536,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns model
-

GET /service-design-and-creation/models/model/{model-invariant-id}

+
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: - ServiceDesignAndCreation + Network
-

returns model

+

returns vlan

@@ -123582,10 +127563,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -123598,10 +127578,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + interface-name -

Type of the model, e.g., service, resource, widget, etc.

+

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-id + +

This indicates the customers VPN ID associated with this vlan

 query @@ -123637,7 +127770,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /model + /vlan
@@ -123665,17 +127798,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing model
-

PUT /service-design-and-creation/models/model/{model-invariant-id}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing model

+

create or update an existing vlan

@@ -123684,13 +127817,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

- /model + /vlan
@@ -123709,10 +127842,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

+ 		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 @@ -123754,23 +127934,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing model
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing model

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -123786,10 +127978,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -123802,12 +127993,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath string @@ -123816,68 +128007,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns model-vers
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

- Tags: - ServiceDesignAndCreation -
-
-
-

returns model-vers

- -
-
- - - - - - - - - - - - + @@ -123912,29 +128048,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-vers -
-
-
- -
default @@ -123957,19 +128070,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns model-ver
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+
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: - ServiceDesignAndCreation + Network
-

returns model-ver

+

delete an existing vlan

+
+ +

application/json application/xml +

+
- model-invariant-id + interface-name -

Unique identifier corresponding to the main definition of a model in ASDC

+

Name given to the interface

 path @@ -123890,17 +128025,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + vlan-interface -

Type of the model, e.g., service, resource, widget, etc.

+

String that identifies the interface

querypath string +
@@ -123984,10 +128102,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -124068,31 +128188,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-ver -
-
-
- -
-
- default +
+ default
@@ -124113,36 +128210,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing model-ver
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing model-ver

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

model-ver object that needs to be created or updated

-

-
-
-
-
- /model-ver -
-
-
-
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -124000,10 +128117,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -124016,40 +128133,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + interface-name -

Type of the model, e.g., service, resource, widget, etc.

+

Name given to the interface

querypath string +
- model-name + vlan-interface -

Name of the model, which can change from version to version.

+

String that identifies the interface

querypath string +
- model-version + resource-version -

Version

+

resource-version for concurrency

 query @@ -124057,6 +128176,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -124157,10 +128237,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -124173,10 +128252,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -124187,73 +128266,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + interface-name -

Unique identifier corresponding to the main definition of a model in ASDC

+

Name given to the interface

 path @@ -124266,10 +128284,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + vlan-interface -

Unique identifier corresponding to one version of a model in ASDC

+

String that identifies the interface

 path @@ -124282,12 +128300,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -124296,100 +128314,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns metadata
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

- Tags: - ServiceDesignAndCreation -
-
-
-

returns metadata

- -
-
- - - - - - - - - - - - + - + - -
- model-invariant-id + prov-status -

Unique identifier corresponding to the main definition of a model in ASDC

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- model-version-id + interface-id -

Unique identifier corresponding to one version of a model in ASDC

+

ID of interface

pathquery string -
- model-type + interface-role -

Type of the model, e.g., service, resource, widget, etc.

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -124401,10 +128361,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-name + interface-id -

Name of the model, which can change from version to version.

+

ID of interface

 query @@ -124416,10 +128376,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version + macaddr -

Version

+

MAC address for the interface

 query @@ -124429,142 +128389,61 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadata -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns metadatum
-

GET /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 + network-name -

Unique identifier corresponding to the main definition of a model in ASDC

+

Name of the network

pathquery string -
- model-version-id + vlan-id-inner -

Unique identifier corresponding to one version of a model in ASDC

+

Inner VLAN tag

pathquery - string + integer -
- metaname + vpn-id +

This indicates the customers VPN ID associated with this vlan

pathquery string -
- model-type + vlan-id-inner -

Type of the model, e.g., service, resource, widget, etc.

+

Inner VLAN tag

 query - string + integer @@ -124572,10 +128451,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-name + neutron-network-id -

Name of the model, which can change from version to version.

+

Neutron network id of the interface that address belongs to

 query @@ -124587,10 +128466,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version + neutron-subnet-id -

Version

+

Neutron id of subnet that address belongs to

 query @@ -124626,7 +128505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /l3-interface-ipv4-address-list
@@ -124654,17 +128533,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing metadatum

+

create or update an existing l3-interface-ipv4-address-list

@@ -124673,13 +128552,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /metadatum + /l3-interface-ipv4-address-list
@@ -124698,26 +128577,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id - -

Unique identifier corresponding to the main definition of a model in ASDC

- 		path - string - - - -
- model-version-id + equipment-name -

Unique identifier corresponding to one version of a model in ASDC

 path @@ -124730,9 +128592,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- metaname + interface-name +

Name that identifies the link aggregate interface

 path @@ -124743,73 +128606,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + interface-name -

Unique identifier corresponding to the main definition of a model in ASDC

+

Name given to the interface

 path @@ -124822,10 +128624,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + vlan-interface -

Unique identifier corresponding to one version of a model in ASDC

+

String that identifies the interface

 path @@ -124838,9 +128640,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- metaname + l3-interface-ipv4-address +

IP address

 path @@ -124851,22 +128654,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -124898,19 +128685,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns model-elements
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

+
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: - ServiceDesignAndCreation + Network
-

returns model-elements

+

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 +
+
+
+
@@ -124925,10 +128729,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -125009,29 +128815,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-elements -
-
-
- -
default @@ -125054,19 +128837,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

returns model-element

+

delete an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -124941,10 +128744,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -124957,47 +128760,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + interface-name -

Type of the model, e.g., service, resource, widget, etc.

+

Name given to the interface

querypath string +
- model-name + vlan-interface -

Name of the model, which can change from version to version.

+

String that identifies the interface

querypath string +
- model-version + l3-interface-ipv4-address -

Version

+

IP address

querypath string +
@@ -125081,10 +128869,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -125180,29 +128971,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-element -
-
-
- -
default @@ -125225,17 +128993,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing model-element

+

see node definition for valid relationships

@@ -125244,13 +129012,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model-element object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /model-element + /relationship
@@ -125269,10 +129037,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + - + + + + + + + + - + + + + + + + + - -
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -125097,10 +128884,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -125113,9 +128900,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -125128,40 +128916,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + vlan-interface -

Type of the model, e.g., service, resource, widget, etc.

+

String that identifies the interface

querypath string +
- model-name + l3-interface-ipv4-address -

Name of the model, which can change from version to version.

+

IP address

querypath string +
- model-version + resource-version -

Version

+

resource-version for concurrency

 query @@ -125169,6 +128959,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -125285,10 +129052,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -125301,9 +129068,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + 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 @@ -125345,17 +129145,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing model-element

+

delete an existing relationship

@@ -125377,10 +129177,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -125393,10 +129192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -125409,9 +129208,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -125424,12 +129224,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path string @@ -125469,17 +129285,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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: - ServiceDesignAndCreation + Network
-

returns model-constraints

+

returns l3-interface-ipv6-address-list

@@ -125496,10 +129312,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -125512,10 +129327,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -125528,9 +129343,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -125543,25 +129359,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + vlan-interface -

Type of the model, e.g., service, resource, widget, etc.

+

String that identifies the interface

querypath string +
- model-name + l3-interface-ipv6-address -

Name of the model, which can change from version to version.

+

IP address

+ 		path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -125573,10 +129406,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version + interface-id -

Version

+

ID of interface

 query @@ -125586,153 +129419,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-role -

Unique identifier corresponding to the main definition of a model in ASDC

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

pathquery string -
- model-version-id + interface-id -

Unique identifier corresponding to one version of a model in ASDC

+

ID of interface

pathquery string -
- model-element-uuid + macaddr +

MAC address for the interface

pathquery string -
- model-constraint-uuid + network-name +

Name of the network

pathquery string -
- model-type + vlan-id-inner -

Type of the model, e.g., service, resource, widget, etc.

+

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

 query @@ -125744,10 +129511,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-name + vlan-id-inner -

Name of the model, which can change from version to version.

+

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

 query @@ -125759,10 +129541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version + neutron-subnet-id -

Version

+

Neutron id of subnet that address belongs to

 query @@ -125798,7 +129580,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /model-constraint + /l3-interface-ipv6-address-list
@@ -125826,17 +129608,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing model-constraint
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing model-constraint

+

create or update an existing l3-interface-ipv6-address-list

@@ -125845,13 +129627,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model-constraint object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /model-constraint + /l3-interface-ipv6-address-list
@@ -125870,10 +129652,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -125886,10 +129667,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -125902,9 +129683,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -125917,9 +129699,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address +

IP address

 path @@ -125961,23 +129760,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing model-constraint
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing model-constraint

+

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 +
+
+
@@ -125993,10 +129804,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -126009,10 +129819,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -126025,9 +129835,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -126040,9 +129851,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + vlan-interface +

String that identifies the interface

 path @@ -126055,12 +129867,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -126100,19 +129912,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns constrained-element-sets
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

+
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: - ServiceDesignAndCreation + Network
-

returns constrained-element-sets

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -126127,10 +129944,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - @@ -126241,29 +130046,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /constrained-element-sets -
-
-
- -
default @@ -126286,19 +130068,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns constrained-element-set
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
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: - ServiceDesignAndCreation + Network
-

returns constrained-element-set

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -126143,10 +129959,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -126159,9 +129975,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -126174,9 +129991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + vlan-interface +

String that identifies the interface

 path @@ -126189,40 +130007,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-type + l3-interface-ipv6-address -

Type of the model, e.g., service, resource, widget, etc.

+

IP address

querypath string +
- model-name + resource-version -

Name of the model, which can change from version to version.

- 		query - string - - -
- model-version - -

Version

+

resource-version for concurrency

 query @@ -126230,6 +130034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -126313,10 +130112,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -126329,10 +130127,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -126345,9 +130143,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -126360,9 +130159,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + vlan-interface +

String that identifies the interface

 path @@ -126375,7 +130175,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + 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 +

+
+
+ + + + + + + + + + + + + @@ -126390,47 +130267,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + - + @@ -126442,29 +130338,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /constrained-element-set -
-
-
- -
default @@ -126487,17 +130360,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing constrained-element-set
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing constrained-element-set

+

see node definition for valid relationships

@@ -126506,13 +130379,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

constrained-element-set object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

- /constrained-element-set + /relationship
@@ -126531,26 +130404,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
+ equipment-name
- model-type + interface-name -

Type of the model, e.g., service, resource, widget, etc.

+

Name that identifies the link aggregate interface

querypath string +
- model-name + interface-name -

Name of the model, which can change from version to version.

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string +
- model-version + l3-interface-ipv6-address -

Version

+

IP address

querypath string +
- model-invariant-id - -

Unique identifier corresponding to the main definition of a model in ASDC

- 		path - string - - - -
- model-version-id + equipment-name -

Unique identifier corresponding to one version of a model in ASDC

 path @@ -126563,9 +130419,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name that identifies the link aggregate interface

 path @@ -126578,9 +130435,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + interface-name +

Name given to the interface

 path @@ -126593,9 +130451,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + vlan-interface +

String that identifies the interface

 path @@ -126637,17 +130496,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing constrained-element-set
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing constrained-element-set

+

delete an existing relationship

@@ -126669,26 +130528,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id - -

Unique identifier corresponding to the main definition of a model in ASDC

- 		path - string - - - -
- model-version-id + equipment-name -

Unique identifier corresponding to one version of a model in ASDC

 path @@ -126701,9 +130543,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name that identifies the link aggregate interface

 path @@ -126716,9 +130559,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + interface-name +

Name given to the interface

 path @@ -126731,9 +130575,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + vlan-interface +

String that identifies the interface

 path @@ -126744,22 +130589,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -126791,19 +130620,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns element-choice-sets
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: - ServiceDesignAndCreation + Network
-

returns element-choice-sets

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -126818,10 +130664,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -126834,10 +130679,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the link aggregate interface

 path @@ -126848,9 +130693,70 @@ 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}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + @@ -126865,9 +130771,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- model-element-uuid + equipment-name
- model-constraint-uuid + interface-name +

Name that identifies the link aggregate interface

 path @@ -126878,9 +130785,65 @@ 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 p-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + @@ -126895,40 +130858,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -127096,9 +130967,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -127329,9 +131124,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + equipment-name
- 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 + prov-status -

Version

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -126964,7 +130897,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /element-choice-sets + /p-interfaces
@@ -126992,17 +130925,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns element-choice-set
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
returns p-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: - ServiceDesignAndCreation + Network
-

returns element-choice-set

+

returns p-interface

@@ -127019,69 +130952,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + equipment-name
- element-choice-set-uuid + interface-name +

Name that identifies the physical interface

 path @@ -127111,25 +130983,10 @@ 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 + prov-status -

Name of the model, which can change from version to version.

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -127141,10 +130998,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version + prov-status -

Version

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -127180,7 +131037,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /element-choice-set + /p-interface
@@ -127208,17 +131065,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing element-choice-set
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
create or update an existing p-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: - ServiceDesignAndCreation + Network
-

create or update an existing element-choice-set

+

create or update an existing p-interface

@@ -127227,13 +131084,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

element-choice-set object that needs to be created or updated

+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)

- /element-choice-set + /p-interface
@@ -127252,69 +131109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + equipment-name
- element-choice-set-uuid + interface-name +

Name that identifies the physical interface

 path @@ -127373,23 +131169,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing element-choice-set
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

+
update an existing p-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: - ServiceDesignAndCreation + Network
-

delete an existing element-choice-set

+

update an existing p-interface

application/json application/xml

+
+
+

p-interface object that needs to be created or updated.

+

+
+
+
+
+ /p-interface +
+
+
@@ -127405,39 +131213,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -127452,9 +131228,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- 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 + equipment-name
- model-constraint-uuid + interface-name +

Name that identifies the physical interface

 path @@ -127465,9 +131242,70 @@ 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 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 +

+
+
+ + + + + + + + + + + @@ -127482,9 +131320,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + equipment-name
- element-choice-set-uuid + interface-name +

Name that identifies the physical interface

 path @@ -127542,36 +131381,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/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

+
returns l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

returns l-interfaces

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -127586,39 +131408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -127633,9 +131423,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -127685,6 +131476,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -127707,24 +131521,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

+
returns l-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: - ServiceDesignAndCreation + Network
-

delete an existing relationship

+

returns l-interface

-
- -

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 + equipment-name
- model-constraint-uuid + interface-name +

Name that identifies the physical interface

 path @@ -127648,32 +131439,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + prov-status +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- element-choice-set-uuid + prov-status +

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
@@ -127739,10 +131548,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + + + + + + + + @@ -127838,6 +131677,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
default @@ -127860,17 +131722,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

create or update an existing l-interface

@@ -127879,13 +131741,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

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

- /relationship + /l-interface
@@ -127904,10 +131766,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - + +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -127755,10 +131563,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the physical interface

 path @@ -127771,9 +131579,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -127786,47 +131595,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + prov-status +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- constrained-element-set-uuid + prov-status +

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- element-choice-set-uuid + interface-id +

ID of interface

pathquery + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query string -
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -127920,10 +131781,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the physical interface

 path @@ -127936,9 +131797,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name given to the interface

 path @@ -127949,10 +131811,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid -
+
+ +
+

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 +
+
+
+
+
+ + + + + + + + + + + + + @@ -127966,9 +131901,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -128846,9 +133062,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + path
- constrained-element-set-uuid + interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name +

Name given to the interface

 path @@ -128010,17 +131962,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

+
delete 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: - ServiceDesignAndCreation + Network
-

delete an existing relationship

+

delete an existing l-interface

@@ -128042,26 +131994,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id - -

Unique identifier corresponding to the main definition of a model in ASDC

- 		path - string - - - -
- model-version-id + equipment-name -

Unique identifier corresponding to one version of a model in ASDC

 path @@ -128074,9 +132009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -128089,9 +132025,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-constraint-uuid + interface-name +

Name given to the interface

 path @@ -128104,11 +132041,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- constrained-element-set-uuid + resource-version +

resource-version for concurrency

pathquery string @@ -128148,36 +132086,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -128192,10 +132113,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -128208,10 +132128,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the physical interface

 path @@ -128224,9 +132144,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address +

IP address

 path @@ -128237,6 +132174,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
@@ -128246,6 +132303,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
default @@ -128268,23 +132348,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -128300,10 +132392,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -128316,10 +132407,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the physical interface

 path @@ -128332,9 +132423,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-element-uuid + interface-name + +

Name given to the interface

+ 		path + string + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -128376,17 +132484,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -128395,13 +132503,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

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -128420,10 +132528,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -128436,10 +132543,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -128481,17 +132620,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

+
delete 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: - ServiceDesignAndCreation + Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -128513,10 +132652,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -128529,10 +132667,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-name -

Unique identifier corresponding to one version of a model in ASDC

+

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -128543,6 +132713,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -128574,13 +132760,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

+

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: - ServiceDesignAndCreation + Network
@@ -128593,7 +132779,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -128618,10 +132804,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

+ 		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 @@ -128663,13 +132896,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/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: - ServiceDesignAndCreation + Network
@@ -128695,10 +132928,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + equipment-name -

Unique identifier corresponding to the main definition of a model in ASDC

+ 		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 @@ -128740,81 +133020,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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}

+
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: - ServiceDesignAndCreation + Network
-

returns named-query

+

returns l3-interface-ipv6-address-list

@@ -128831,7 +133047,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-uuid + equipment-name
- named-query-name + 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 @@ -128884,7 +133254,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /named-query + /l3-interface-ipv6-address-list
@@ -128912,17 +133282,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing named-query
-

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing named-query

+

create or update an existing l3-interface-ipv6-address-list

@@ -128931,13 +133301,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

named-query object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /named-query + /l3-interface-ipv6-address-list
@@ -128956,9 +133326,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-uuid + 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 @@ -129000,23 +133418,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing named-query
-

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing named-query

+

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 +
+
+
@@ -129032,7 +133462,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129047,12 +133477,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- named-query-uuid + equipment-name
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -129092,19 +133554,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns named-query-elements
-

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

+
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: - ServiceDesignAndCreation + Network
-

returns named-query-elements

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -129119,7 +133586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129134,53 +133601,80 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- named-query-uuid + equipment-name
- named-query-name + interface-name +

Name that identifies the physical interface

querypath string +
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /named-query-elements -
-
-
- -
-
- default - +
+ 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 +
@@ -129200,19 +133694,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

returns named-query-element

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -129227,7 +133738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129242,9 +133753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + @@ -129278,29 +133808,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /named-query-element -
-
-
- -
default @@ -129323,35 +133830,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing named-query-element

+

delete an existing relationship

application/json application/xml

-
-
-

named-query-element object that needs to be created or updated

-

-
-
-
-
- /named-query-element -
-
-
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -129257,16 +133769,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-name + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address +

IP address

querypath string +
@@ -129367,7 +133862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129382,9 +133877,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- named-query-uuid + equipment-name
- named-query-element-uuid + 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 @@ -129426,23 +133954,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing named-query-element

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -129458,7 +133998,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129473,9 +134013,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -129488,12 +134029,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath string @@ -129533,19 +134074,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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: - ServiceDesignAndCreation + Network
-

returns property-constraints

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -129560,7 +134106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129575,9 +134121,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -129611,29 +134160,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /property-constraints -
-
-
- -
default @@ -129656,17 +134182,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

returns property-constraint

+

returns sriov-vfs

@@ -129683,7 +134209,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -129698,9 +134224,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -129590,16 +134137,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-name + interface-name +

Name given to the interface

querypath string +
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -129713,9 +134240,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- property-constraint-uuid + interface-name +

Name given to the interface

 path @@ -129728,9 +134256,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-name + 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 @@ -129766,7 +134355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /property-constraint + /sriov-vfs
@@ -129794,36 +134383,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing property-constraint

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

property-constraint object that needs to be created or updated

-

-
-
-
-
- /property-constraint -
-
-
-
@@ -129838,7 +134410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -129853,9 +134425,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -129868,9 +134441,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- property-constraint-uuid + interface-name +

Name given to the interface

 path @@ -129881,72 +134455,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing 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 + pci-id +

PCI ID used to identify the sriov-vf

 path @@ -129959,40 +134473,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-element-uuid + prov-status +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- property-constraint-uuid + prov-status +

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- resource-version + interface-id -

resource-version for concurrency

+

ID of interface

 query @@ -130000,100 +134514,89 @@ 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 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 + macaddr +

MAC address for the interface

pathquery string -
- named-query-element-uuid + network-name +

Name of the network

pathquery string -
- named-query-name + 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 @@ -130129,7 +134632,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /related-lookups + /sriov-vf
@@ -130157,19 +134660,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

returns related-lookup

+

create or update an existing sriov-vf

+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
@@ -130184,7 +134704,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -130199,9 +134719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -130250,29 +134774,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /related-lookup -
-
-
- -
default @@ -130295,17 +134796,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing related-lookup

+

update an existing sriov-vf

@@ -130314,13 +134815,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

related-lookup object that needs to be created or updated

+

sriov-vf object that needs to be created or updated.

- /related-lookup + /sriov-vf
@@ -130339,7 +134840,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -130354,9 +134855,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + @@ -130460,9 +134979,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + @@ -130594,9 +135131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + @@ -130700,9 +135255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -130214,9 +134735,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- related-lookup-uuid + interface-name +

Name given to the interface

 path @@ -130229,16 +134751,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-name + pci-id +

PCI ID used to identify the sriov-vf

querypath string +
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -130369,9 +134871,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- related-lookup-uuid + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id +

PCI ID used to identify the sriov-vf

 path @@ -130413,17 +134932,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing related-lookup

+

delete an existing sriov-vf

@@ -130445,7 +134964,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -130475,9 +134995,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- related-lookup-uuid + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id +

PCI ID used to identify the sriov-vf

 path @@ -130535,13 +135072,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/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 /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: - ServiceDesignAndCreation + Network
@@ -130554,7 +135091,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -130579,7 +135116,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -130609,9 +135147,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- related-lookup-uuid + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id +

PCI ID used to identify the sriov-vf

 path @@ -130653,13 +135208,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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: - ServiceDesignAndCreation + Network
@@ -130685,7 +135240,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -130715,9 +135271,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- related-lookup-uuid + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id +

PCI ID used to identify the sriov-vf

 path @@ -130759,36 +135332,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

+
returns vlans
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

returns vlans

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -130803,7 +135359,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -130818,9 +135374,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- named-query-uuid + equipment-name
- named-query-element-uuid + interface-name +

Name that identifies the physical interface

 path @@ -130831,72 +135388,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /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 -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -130931,6 +135488,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
default @@ -130953,36 +135533,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

returns vlan

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
- named-query-uuid + interface-name +

Name given to the interface

 path @@ -130909,17 +135406,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-element-uuid + prov-status +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery + 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 -
@@ -130997,7 +135560,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -131010,72 +135573,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- named-query-uuid + equipment-name
-
- -
-

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 + interface-name +

Name that identifies the physical interface

 path @@ -131086,132 +135589,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
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 + interface-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+

Name given to the interface

 path @@ -131224,10 +135607,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + vlan-interface -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

String that identifies the interface

 path @@ -131238,6 +135621,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
@@ -131264,7 +135752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /service-capability + /vlan
@@ -131292,17 +135780,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing service-capability
-

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing service-capability

+

create or update an existing vlan

@@ -131311,13 +135799,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service-capability object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /service-capability + /vlan
@@ -131336,10 +135824,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-type + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path @@ -131352,10 +135839,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -131397,23 +135916,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing service-capability
-

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing service-capability

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -131429,10 +135960,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- service-type + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path @@ -131445,10 +135975,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name that identifies the physical interface

 path @@ -131461,12 +135991,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string @@ -131506,35 +136052,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

see node definition for valid relationships

+

delete an existing vlan

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -131550,10 +136084,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- service-type + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path @@ -131566,10 +136099,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -131580,6 +136145,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -131611,24 +136192,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

+
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: - ServiceDesignAndCreation + Network
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -131643,10 +136219,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- service-type + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path @@ -131659,10 +136234,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name that identifies the 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 @@ -131673,51 +136296,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-id + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
-
-

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

@@ -131740,7 +136472,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /services + /l3-interface-ipv4-address-list
@@ -131768,19 +136500,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns service
-

GET /service-design-and-creation/services/service/{service-id}

+
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: - ServiceDesignAndCreation + Network
-

returns service

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -131795,10 +136544,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + @@ -131833,29 +136630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service -
-
-
- -
default @@ -131878,17 +136652,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing service
-

PUT /service-design-and-creation/services/service/{service-id}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing service

+

update an existing l3-interface-ipv4-address-list

@@ -131897,13 +136671,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /service + /l3-interface-ipv4-address-list
@@ -131922,10 +136696,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- service-id + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path @@ -131811,17 +136559,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-description + interface-name -

Description of the service

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path string +
- service-id + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		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 @@ -131967,17 +136804,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing service
-

DELETE /service-design-and-creation/services/service/{service-id}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing service

+

delete an existing l3-interface-ipv4-address-list

@@ -131999,10 +136836,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		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 @@ -132060,13 +136960,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/services/service/{service-id}/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: - ServiceDesignAndCreation + Network
@@ -132079,7 +136979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -132104,10 +137004,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path @@ -132118,44 +137017,108 @@ 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.

- -
-
-
- -
-
- -
-
-
+
+ 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 /service-design-and-creation/services/service/{service-id}/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: - ServiceDesignAndCreation + Network
@@ -132181,10 +137144,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + equipment-name -

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		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 @@ -132226,19 +137252,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vnf-images
-

GET /service-design-and-creation/vnf-images

+
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: - ServiceDesignAndCreation + Network
-

returns vnf-images

+

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-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 @@ -132262,7 +137532,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /vnf-images + /l3-interface-ipv6-address-list
@@ -132290,19 +137560,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vnf-image
-

GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+
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: - ServiceDesignAndCreation + Network
-

returns vnf-image

+

create or update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
@@ -132317,10 +137604,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -132385,29 +137690,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vnf-image -
-
-
- -
default @@ -132430,17 +137712,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vnf-image
-

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+
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: - ServiceDesignAndCreation + Network
-

create or update an existing vnf-image

+

update an existing l3-interface-ipv6-address-list

@@ -132449,13 +137731,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vnf-image object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /vnf-image + /l3-interface-ipv6-address-list
@@ -132474,10 +137756,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -82,6 +89,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -112,6 +124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -142,6 +159,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -172,6 +194,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -202,6 +229,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -232,6 +264,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -252,6 +289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -282,6 +324,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -322,6 +369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -352,6 +404,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -382,6 +439,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -402,6 +464,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -417,6 +484,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -442,6 +514,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -482,6 +559,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -512,6 +594,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -527,6 +614,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -552,6 +644,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -602,6 +699,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -627,6 +729,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -652,6 +759,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -682,6 +794,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -712,6 +829,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -732,6 +854,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -772,6 +899,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -802,6 +934,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -822,6 +959,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -842,6 +984,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -857,6 +1004,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -882,6 +1034,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -922,6 +1079,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -952,6 +1114,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -967,6 +1134,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -992,6 +1164,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1042,6 +1219,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1062,6 +1244,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1077,6 +1264,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1102,6 +1294,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1142,6 +1339,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1172,6 +1374,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1187,6 +1394,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1212,6 +1424,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1262,6 +1479,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1302,6 +1524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1323,200 +1550,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-image-uuid + equipment-name -

Unique ID of this asset

 path @@ -132333,47 +137619,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- application + interface-name -

The application that the image instantiates.

+

Name that identifies the physical interface

querypath string +
- application-vendor + interface-name -

The vendor of the application.

+

Name given to the interface

querypath string +
- application-version + vlan-interface -

The version of the application.

+

String that identifies the interface

querypath + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string +
- vnf-image-uuid + equipment-name -

Unique ID of this asset

+ 		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 @@ -132519,17 +137864,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vnf-image
-

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+
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: - ServiceDesignAndCreation + Network
-

delete an existing vnf-image

+

delete an existing l3-interface-ipv6-address-list

@@ -132551,10 +137896,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-image-uuid + equipment-name -

Unique ID of this asset

+ 		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 @@ -132612,13 +138020,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/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: - ServiceDesignAndCreation + Network
@@ -132631,7 +138039,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -132656,10 +138064,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-image-uuid + equipment-name -

Unique ID of this asset

+ 		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 @@ -132701,13 +138172,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/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: - ServiceDesignAndCreation + Network
@@ -132733,10 +138204,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-image-uuid + equipment-name -

Unique ID of this asset

+ 		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 @@ -132777,25 +138311,15199 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - -

Schema definitions

- -
-
-

action: - object - - - -

-
-
+ + +
+
+
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/v10/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 + + + +
+
-
-
-
- action-type: +
+

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/v10/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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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 + + +
+
+ +
+

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/v10/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 + + +
+
+ +
+

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 + + +
+
+ +
+

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/v10/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 + + +
+
+ +
+

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 + + +
+
+ +
+

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/v10/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 + + +
+
+ +
+

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 + + +
+
+ +
+

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/v10/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 + + +
+
+ +
+

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 + + +
+
+ +
+

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/v10/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 + + +
+
+ +
+

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 + + +
+
+ +
+

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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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 generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
    • +
  • TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
    • +
  • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • +
  • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
+ +
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

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 + + + +
+ +
+
+
+
+
+
+
+
+
+

cloud-region: + object + + + +

+
+
+
+

cloud-region designates an installation of a cloud cluster or region or instantiation

+ +
    +
  • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
    • +
  • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
    • +
  • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
+ +
+ +
+
+
+ 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.

+
+ +
+
+
+ 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 + + + +
+ +
+
+
+
+
+
+
+
+
+

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 oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
    • +
  • COMPLEX is DELETED when these are DELETED CTAG-POOL
+ +
+ +
+
+
+ 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 @@ -132805,8 +153513,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- action-data: +
+ ctag-pools: object[] @@ -132816,7 +153524,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- action-data + ctag-pool @@ -132825,52 +153533,33 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - -
-
-
-
-

action-data: - object - - - -

-
-
- -
-
-
- property-name: - string +
+ relationship-list: + object[]
-
- -
-
-
- property-value: - string - -
-
-
+
+ relationship + + + +
+ +
+
-
+
-

actions: +

complexes: object @@ -132879,35 +153568,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

APIs that are more action related than REST (e.g., notify, update).

+

Collection of physical locations that can house cloud-regions.

-
- update: - object - - -
-
- -
- -
- update - - - -
- -
-
-
-
- notify: - object +
+ complex: + object[]
@@ -132916,7 +153585,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- notify + complex @@ -132929,9 +153598,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-

allotted-resource: +

configuration: object @@ -132940,105 +153609,104 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Represents a slice or partial piece of a resource that gets separately allotted

-
Default Delete Scope
-

CASCADE_TO_CHILDREN

+

Port Mirror Configuration.

    -
  • TO generic-vnf (Many2Many)
    • -
  • TO l3-network (Many2Many)
    • -
  • TO instance-group (Many2Many)
    • -
  • TO network-policy (One2One)
    • -
  • TO vlan (Many2Many)
    • -
  • TO tunnel-xconnect (comprises allotted-resource, One2One)
    • -
  • FROM service-instance (is composed of allotted-resource)
    • -
  • FROM service-instance
+
  • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • +
  • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • CONFIGURATION is DELETED when these are DELETED METADATUM
    • +
  • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
    • -
    - id: +
    + configuration-id: string
    -

    Allotted Resource id UUID assigned to this instance.

    +

    UUID assigned to configuration.

    -
    - description: +
    + management-option: string
    -

    The descriptive information assigned to this allotted resource instance

    +

    Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

    -
    - selflink: +
    + configuration-name: string
    -

    Link back to more information in the controller

    +

    Name of the configuration.

    -
    - model-invariant-id: +
    + configuration-type: string +
    -

    the ASDC model id for this resource or service model.

    +

    port-mirroring-configuration.

    -
    - model-version-id: +
    + configuration-sub-type: string +
    -

    the ASDC model version for this resource or service model.

    +

    vprobe, pprobe.

    -
    - persona-model-version: +
    + model-invariant-id: string
    -

    the ASDC model version for this resource or service model.

    +

    the ASDC model id for this resource or service model.

    -
    - resource-version: +
    + model-version-id: string
    -

    Concurrency value

    +

    the ASDC model version for this resource or service model.

    @@ -133048,9 +153716,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen string +
    -

    Orchestration status

    +

    Orchestration status of the configuration.

    @@ -133060,39 +153729,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen string +
    -

    Indicator for whether the resource is considered operational

    +

    Indicator for whether the resource is considered operational.

    -
    - type: +
    + configuration-selflink: string +
    -

    Generic description of the type of allotted resource.

    +

    URL to endpoint where AAI can get more details from SDN-GC.

    -
    - role: +
    + model-customization-id: string +
    -

    role in the network that this resource will be providing.

    +

    id of the configuration used to customize the resource

    -
    - tunnel-xconnects: +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: object[] @@ -133102,7 +153786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tunnel-xconnect + relationship @@ -133111,8 +153795,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - relationship-list: +
    + metadata: object[] @@ -133122,7 +153806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + metadatum @@ -133135,9 +153819,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    allotted-resources: +

    configurations: object @@ -133146,14 +153830,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This object is used to store slices of services being offered

    +

    Collection of configurations

    -
    - allotted-resource: +
    + configuration: object[] @@ -133163,7 +153847,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - allotted-resource + configuration @@ -133176,9 +153860,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    availability-zone: +

    connector: object @@ -133187,70 +153871,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Availability zone, a collection of compute hosts/pservers

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    +

    Collection of resource instances used to connect a variety of disparate inventory widgets

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of availability-zone)
      • -
    • FROM ctag-pool
      • -
    • FROM dvs-switch
      • -
    • FROM generic-vnf
      • -
    • FROM pserver
      • -
    • FROM vce
    +
  • 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
    • -
    - availability-zone-name: +
    + resource-instance-id: string
    -

    Name of the availability zone. Unique across a cloud region

    +

    Unique id of resource instance.

    -
    - hypervisor-type: +
    + resource-version: string -
    -

    Type of hypervisor. Source of truth should define valid values.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - operational-status: +
    + model-invariant-id: string
    -

    State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

    +

    the ASDC model id for this resource or service model.

    -
    - resource-version: +
    + model-version-id: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    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.

    @@ -133272,6 +153985,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    + +
    + metadata: + object[] + + +
    +
    + +
    + +
    + metadatum + + + +
    +
    @@ -133279,9 +154012,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    availability-zones: +

    connectors: object @@ -133290,14 +154023,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of availability zones

    +

    Collection of resource instances used to connect a variety of disparate inventory widgets

    -
    - availability-zone: +
    + connector: object[] @@ -133307,7 +154040,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + connector @@ -133320,9 +154053,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    az-and-dvs-switches: +

    constrained-element-set: object @@ -133330,12 +154063,69 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    This is how we would capture constraints defining allowed sets of elements.

    + +
      +
    • TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
      • +
    • TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
      • +
    • FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
      • +
    • CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
    + +
    -
    - dvs-switches: - object +
    + constrained-element-set-uuid: + string + + + +
    +
    +
    + +
    +
    +
    + constraint-type: + string + + + +
    +
    +
    + +
    +
    +
    + check-type: + string + + + +
    +
    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +
    + +
    +
    +
    + element-choice-sets: + object[]
    @@ -133344,7 +154134,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - dvs-switches + element-choice-set @@ -133353,9 +154143,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - availability-zone: - object +
    + relationship-list: + object[]
    @@ -133364,7 +154154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + relationship @@ -133377,9 +154167,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    business: +

    constrained-element-sets: + object + + + +

    +
    +
    + +
    +
    +
    + constrained-element-set: + object[] + + +
    +
    + +
    + +
    + constrained-element-set + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    ctag-assignment: object @@ -133388,14 +154215,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Namespace for business related constructs

    + +
      +
    • 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)
    -
    - connectors: +
    + 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[] @@ -133405,7 +154260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - connector + relationship @@ -133414,8 +154269,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - customers: + + +
    +
    +
    +
    +

    ctag-assignments: + object + + + +

    +
    +
    + +
    +
    +
    + ctag-assignment: object[] @@ -133425,7 +154297,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - customer + ctag-assignment @@ -133438,9 +154310,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    class-of-service: +

    ctag-pool: object @@ -133449,49 +154321,64 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    A collection of C tags (vlan tags) grouped for a specific purpose.

      -
    • FROM site-pair (is composed of class-of-service)
    +
  • TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
    • +
  • TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • -
    - cos: +
    + target-pe: string
    -

    unique identifier of probe

    +

    The Target provider edge router

    -
    - probe-id: +
    + availability-zone-name: string +
    -

    identifier of probe

    +

    Name of the availability zone

    -
    - probe-type: +
    + ctag-pool-purpose: string +
    -

    type of probe

    +

    Describes what the intended purpose of this pool is.

    +
    + +
    +
    +
    + ctag-values: + string + + +
    +
    +

    Comma separated list of ctags

    @@ -133532,9 +154419,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    classes-of-service: +

    ctag-pools: object @@ -133542,15 +154429,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    class-of-service of probe

    - -
    -
    - class-of-service: +
    + ctag-pool: object[] @@ -133560,7 +154443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - class-of-service + ctag-pool @@ -133573,9 +154456,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-infrastructure: +

    customer: object @@ -133584,14 +154467,69 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Namespace for cloud infrastructure.

    +

    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
    -
    - complexes: +
    + 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[] @@ -133601,7 +154539,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - complex + service-subscription @@ -133610,8 +154548,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - cloud-regions: +
    + relationship-list: object[] @@ -133621,7 +154559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region + relationship @@ -133630,8 +154568,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - network-profiles: + + +
    +
    +
    +
    +

    customers: + object + + + +

    +
    +
    +
    +

    Collection of customer identifiers to provide linkage back to BSS information.

    + +
    + +
    +
    +
    + customer: object[] @@ -133641,7 +154600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-profile + customer @@ -133650,8 +154609,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - pservers: + + +
    +
    +
    +
    +

    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[] @@ -133661,7 +154662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver + relationship @@ -133670,8 +154671,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - virtual-data-centers: + + +
    +
    +
    +
    +

    cvlan-tags: + object + + + +

    +
    +
    + +
    +
    +
    + cvlan-tag-entry: object[] @@ -133681,7 +154699,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - virtual-data-center + cvlan-tag-entry @@ -133694,9 +154712,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-region: +

    dvs-switch: object @@ -133705,124 +154723,428 @@ 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

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    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 complex (Many2One)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO tenant (comprises cloud-region, One2Many)
      • -
    • TO image (comprises cloud-region, One2Many)
      • -
    • TO flavor (comprises cloud-region, One2Many)
      • -
    • TO availability-zone (comprises cloud-region, One2Many)
      • -
    • TO oam-network (comprises cloud-region, One2Many)
      • -
    • TO dvs-switch (comprises cloud-region, One2Many)
      • -
    • TO volume-group (comprises cloud-region, One2Many)
      • -
    • TO group-assignment (comprises cloud-region, One2Many)
      • -
    • TO snapshot (comprises cloud-region, One2Many)
      • -
    • TO zone (Many2One)
      • -
    • FROM pserver
      • -
    • FROM logical-link
    +
  • 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)
    • -
    - cloud-owner: +
    + switch-name: string
    -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    DVS switch name

    -
    - cloud-region-id: +
    + vcenter-url: string
    -

    Identifier used by the vendor for the region. Second part of composite key

    +

    URL used to reach the vcenter

    -
    - cloud-type: +
    + resource-version: string
    -

    Type of the cloud (e.g., openstack)

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - owner-defined-type: +
    + 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
    -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    - cloud-region-version: +
    + direction: string
    -

    Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

    -
    - identity-url: +
    + multiplicityRule: string
    -

    URL of the keystone identity service

    -
    - cloud-zone: +
    + isParent: + boolean + + +
    +
    +
    + +
    +
    +
    + usesResource: + boolean + + +
    +
    +
    + +
    +
    +
    + hasDelTarget: + boolean + + +
    +
    +
    + +
    +
    +
    + SVC-INFRA: + boolean + + +
    +
    +
    + +
    +
    +
    + SVC-INFRA-REV: + boolean + + +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    edge-tag-query-request: + object + + + +

    +
    +
    + +
    +
    +
    + edge-tag: string
    -

    Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

    -
    - complex-name: +
    + 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
    -

    complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

    @@ -133834,13 +155156,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - volume-groups: +
    + model-elements: object[] @@ -133850,7 +155171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group + model-element @@ -133859,8 +155180,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - tenants: +
    + relationship-list: object[] @@ -133870,7 +155191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant + relationship @@ -133879,8 +155200,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - flavors: + + +
    +
    +
    +
    +

    element-choice-sets: + object + + + +

    +
    +
    + +
    +
    +
    + element-choice-set: object[] @@ -133890,7 +155228,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - flavor + element-choice-set @@ -133899,48 +155237,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - group-assignments: - object[] + + +
    +
    +
    +
    +

    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.

    -
    - group-assignment - - - -
    - -
    -
    +
    -
    - snapshots: - object[] +
    + resource-uuid: + string +
    +

    Unique ID of an entitlement resource.

    +
    + +
    +
    +
    + resource-version: + string + +
    +
    +

    Concurrency value

    -
    - snapshot - - - -
    - -
    -
    +
    -
    - images: +
    + relationship-list: object[] @@ -133950,7 +155311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - image + relationship @@ -133959,8 +155320,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - dvs-switches: + + +
    +
    +
    +
    +

    entitlements: + object + + + +

    +
    +
    +
    +

    Entitlements, keyed by group-uuid and resource-uuid, related to license management

    + +
    + +
    +
    +
    + entitlement: object[] @@ -133970,7 +155352,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - dvs-switch + entitlement @@ -133979,29 +155361,59 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - oam-networks: - object[] + + +
    +
    +
    +
    +

    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.

    -
    - oam-network - - - -
    - -
    -
    +
    -
    - availability-zones: - object[] +
    + esr-system-info-list: + object
    @@ -134010,7 +155422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + esr-system-info-list @@ -134021,7 +155433,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -134030,7 +155442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -134043,9 +155455,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-regions: +

    esr-ems-list: object @@ -134056,8 +155468,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - cloud-region: +
    + esr-ems: object[] @@ -134067,7 +155479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region + esr-ems @@ -134080,9 +155492,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    +
    -

    complex: +

    esr-system-info: object @@ -134091,246 +155503,261 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of physical locations that can house cloud-regions.

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

    +

    Persist common address information of external systems.

      -
    • TO ctag-pool (comprises complex, Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • FROM availability-zone
      • -
    • FROM cloud-region
      • -
    • FROM oam-network
      • -
    • FROM pserver
      • -
    • FROM pnf
      • -
    • FROM vce
      • -
    • FROM vpls-pe
      • -
    • FROM volume-group
      • -
    • FROM zone
    +
  • FROM 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)
    • -
    - physical-location-id: +
    + esr-system-info-id: string
    -

    Unique identifier for physical location, e.g., CLLI

    +

    Unique ID of esr system info.

    -
    - data-center-code: +
    + system-name: string
    -

    Data center code which can be an alternate way to identify a complex

    +

    name of external system.

    -
    - complex-name: +
    + type: string
    -

    Gamma complex name for LCP instance.

    +

    type of external systems.

    -
    - identity-url: +
    + vendor: string
    -

    URL of the keystone identity service

    +

    vendor of external systems.

    -
    - resource-version: +
    + version: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    version of external systems.

    -
    - physical-location-type: +
    + service-url: string -
    -

    Type, e.g., central office, data center.

    +

    url used to access external systems.

    -
    - street1: +
    + user-name: string
    +

    username used to access external systems.

    -
    - street2: +
    + password: string +
    +

    password used to access external systems.

    -
    - city: +
    + system-type: string
    +

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    -
    - state: +
    + protocol: string
    +

    protocol of third party SDNC, for example netconf/snmp.

    -
    - postal-code: +
    + ssl-cacert: string -
    +

    ca file content if enabled ssl on auth-url.

    -
    - country: - string +
    + ssl-insecure: + boolean -
    +

    Whether to verify VIM's certificate.

    -
    - region: +
    + ip-address: string -
    +

    service IP of ftp server.

    -
    - latitude: +
    + port: string
    +

    service port of ftp server.

    -
    - longitude: +
    + cloud-domain: string
    +

    domain info for authentication.

    -
    - elevation: +
    + default-tenant: string
    +

    default tenant of VIM.

    -
    - lata: +
    + passive: + boolean + + +
    +
    +

    ftp passive mode or not.

    +
    + +
    +
    +
    + remote-path: string
    +

    resource or performance data file path.

    -
    - ctag-pools: - object[] +
    + 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.

    -
    - ctag-pool - - - -
    - -
    -
    +
    relationship-list: @@ -134356,9 +155783,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    complexes: +

    esr-system-info-list: object @@ -134367,14 +155794,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of physical locations that can house cloud-regions.

    +

    Collection of persistent block-level external system auth info.

    -
    - complex: +
    + esr-system-info: object[] @@ -134384,7 +155811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - complex + esr-system-info @@ -134397,9 +155824,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    connector: +

    esr-thirdparty-sdnc: object @@ -134408,107 +155835,69 @@ 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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    +

    Persist SDNC address information used by ONAP SDNC.

      -
    • TO virtual-data-center (Many2Many)
      • -
    • TO metadatum (comprises connector, Many2Many)
      • -
    • FROM service-instance
    +
  • 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
    • -
    - resource-instance-id: +
    + thirdparty-sdnc-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.

    +

    Unique ID of SDNC.

    -
    - persona-model-version: +
    + location: string
    -

    the ASDC model version for this resource or service model.

    +

    used for DC type to indicate the location of SDNC, such as Core or Edge.

    -
    - widget-model-id: +
    + product-name: string
    -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    password used to access SDNC server.

    -
    - widget-model-version: +
    + resource-version: string
    -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - relationship-list: - object[] +
    + esr-system-info-list: + object
    @@ -134517,7 +155906,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + esr-system-info-list @@ -134526,9 +155915,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - metadata: - object[] +
    + relationship-list: + object
    @@ -134537,7 +155926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metadatum + relationship-list @@ -134550,9 +155939,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    connectors: +

    esr-thirdparty-sdnc-list: object @@ -134560,15 +155949,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

    - -
    -
    - connector: +
    + esr-thirdparty-sdnc: object[] @@ -134578,7 +155963,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - connector + esr-thirdparty-sdnc @@ -134591,9 +155976,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    constrained-element-set: +

    esr-vnfm: object @@ -134602,51 +155987,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This is how we would capture constraints defining allowed sets of elements.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    +

    Persist VNFM address information used by VF-C.

      -
    • TO element-choice-set (comprises constrained-element-set, One2Many)
      • -
    • FROM model-element (is composed of constrained-element-set)
      • -
    • FROM model-constraint (is composed of constrained-element-set)
    +
  • 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
    • -
    - constrained-element-set-uuid: +
    + vnfm-id: string
    +

    Unique ID of VNFM.

    -
    - constraint-type: +
    + vim-id: string -
    +

    indecate the VIM to deploy VNF.

    -
    - check-type: +
    + certificate-url: string -
    +

    certificate url of VNFM.

    @@ -134658,13 +156041,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - element-choice-sets: - object[] +
    + esr-system-info-list: + object
    @@ -134673,7 +156057,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - element-choice-set + esr-system-info-list @@ -134684,7 +156068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -134693,7 +156077,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -134706,9 +156090,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    constrained-element-sets: +

    esr-vnfm-list: object @@ -134719,8 +156103,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - constrained-element-set: +
    + esr-vnfm: object[] @@ -134730,7 +156114,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set + esr-vnfm @@ -134743,9 +156127,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    +
    -

    ctag-assignment: +

    evc: object @@ -134754,308 +156138,180 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    evc object is an optional child object of the Configuration object.

      -
    • FROM l3-network (is composed of ctag-assignment)
      • -
    • FROM service-instance
    +
  • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    • -
    - vlan-id-inner: - integer +
    + evc-id: + string
    -

    id.

    +

    Unique/key field for the evc object

    -
    - resource-version: +
    + forwarding-path-topology: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    Point-to-Point, Multi-Point

    -
    - relationship-list: - object[] +
    + cir-value: + string
    - +

    Commited Information Rate

    -
    - relationship - - - -
    - -
    -
    +
    -
    -
    -
    -
    -
    -
    -

    ctag-assignments: - object - - - -

    -
    -
    - -
    -
    -
    - ctag-assignment: - object[] +
    + cir-units: + string
    - +

    CIR units

    -
    - ctag-assignment - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    ctag-pool: - object - - - -

    -
    -
    -
    -

    A collection of C tags (vlan tags) grouped for a specific purpose.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - -
      -
    • TO availability-zone (Many2Many)
      • -
    • FROM complex (is composed of ctag-pool)
      • -
    • FROM vpls-pe
    - -
    - -
    -
    -
    - target-pe: +
    + connection-diversity-group-id: string -
    -

    The Target provider edge router

    +

    Diversity Group ID

    -
    - availability-zone-name: +
    + service-hours: string -
    -

    Name of the availability zone

    +

    formerly Performance Group

    -
    - ctag-pool-purpose: +
    + esp-evc-circuit-id: string -
    -

    Describes what the intended purpose of this pool is.

    +

    EVC Circuit ID of ESP EVC

    -
    - ctag-values: +
    + esp-evc-cir-value: string
    -

    Comma separated list of ctags

    +

    Committed Information Rate (For ESP)

    -
    - resource-version: +
    + esp-evc-cir-units: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    CIR units (For ESP)

    -
    - relationship-list: - object[] +
    + esp-itu-code: + string
    - +

    Identifies ESP

    -
    - relationship - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    ctag-pools: - object - - - -

    -
    -
    - -
    -
    -
    - ctag-pool: - object[] +
    + collector-pop-clli: + string
    - +

    Collector POP CLLI (from the hostname of the access pnf)

    -
    - ctag-pool - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    customer: - object - - - -

    -
    -
    -
    -

    customer identifiers to provide linkage back to BSS information.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    - -
      -
    • TO service-subscription (comprises customer, Many2Many)
    - -
    - -
    -
    -
    - global-customer-id: +
    + inter-connect-type-ingress: string -
    -

    Global customer id used across ECOMP to uniquely identify customer.

    +

    Interconnect type on ingress side of EVC.

    -
    - subscriber-name: +
    + tagmode-access-ingress: string -
    -

    Subscriber name, an alternate way to retrieve a customer.

    +

    tagode for collector side of EVC

    -
    - subscriber-type: +
    + tagmode-access-egress: string -
    -

    Subscriber type, a way to provide VID with only the INFRA customers.

    +

    tagMode for network side of EVC

    @@ -135067,31 +156323,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - service-subscriptions: - object[] - - -
    -
    - -
    - -
    - service-subscription - - - -
    - -
    -
    -
    relationship-list: object[] @@ -135116,9 +156352,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    customers: +

    evcs: object @@ -135126,15 +156362,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of customer identifiers to provide linkage back to BSS information.

    - -
    -
    - customer: +
    + evc: object[] @@ -135144,7 +156376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - customer + evc @@ -135157,9 +156389,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cvlan-tag-entry: +

    external-system: object @@ -135167,37 +156399,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Namespace for external system.

    + +
    -
    - cvlan-tag: - integer +
    + esr-ems-list: + object -
    -

    See mis-na-virtualization-platform.yang

    -
    - -
    -
    -
    - resource-version: - string - -
    -
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    +
    + esr-ems-list + + + +
    + +
    +
    -
    - relationship-list: - object[] +
    + esr-vnfm-list: + object
    @@ -135206,7 +156437,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + esr-vnfm-list @@ -135215,26 +156446,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - -
    -
    -
    -
    -

    cvlan-tags: - object - - - -

    -
    -
    - -
    -
    -
    - cvlan-tag-entry: - object[] +
    + esr-thirdparty-sdnc-list: + object
    @@ -135243,7 +156457,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag-entry + esr-thirdparty-sdnc-list @@ -135256,9 +156470,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    dvs-switch: +

    extra-properties: object @@ -135267,58 +156481,14 @@ 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.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - -
      -
    • TO availability-zone (Many2Many)
      • -
    • FROM cloud-region (is composed of dvs-switch)
    +

    Extra properties for inventory item for response list

    -
    - 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: +
    + extra-property: object[] @@ -135328,7 +156498,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + extra-property @@ -135341,9 +156511,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    dvs-switches: +

    extra-property: object @@ -135351,40 +156521,38 @@ 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 GenericVnfs.

    - -
    -
    - dvs-switch: - object[] +
    + property-name: + string
    +
    + +
    +
    +
    + property-value: + string + +
    +
    -
    - dvs-switch - - - -
    - -
    -
    +
    -
    +
    -

    edge-prop-names: +

    flavor: object @@ -135393,192 +156561,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Internal map to define the properties of an edge and interpret the map EdgeRules

    +

    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
    -
    - edgeLabel: +
    + flavor-id: string +
    +

    Flavor id, expected to be unique across cloud-region.

    -
    - direction: +
    + flavor-name: string +
    +

    Flavor name

    -
    - multiplicityRule: - string +
    + flavor-vcpus: + integer
    +

    Number of CPUs

    -
    - isParent: - boolean +
    + flavor-ram: + integer
    +

    Amount of memory

    -
    - usesResource: - boolean +
    + flavor-disk: + integer
    +

    Disk space

    -
    - hasDelTarget: - boolean +
    + flavor-ephemeral: + integer
    +

    Amount of ephemeral disk space

    -
    - SVC-INFRA: - boolean +
    + flavor-swap: + string
    +

    amount of swap space allocation

    -
    - SVC-INFRA-REV: +
    + flavor-is-public: boolean
    +

    whether flavor is available to all users or private to the tenant it was created in.

    -
    -
    -
    -
    -
    -
    -

    edge-tag-query-request: - object - - - -

    -
    -
    - -
    -
    -
    - edge-tag: +
    + flavor-selflink: string +
    +

    URL to endpoint where AAI can get more details

    -
    - result-detail: - string +
    + flavor-disabled: + boolean
    +

    Boolean as to whether this flavor is no longer enabled

    -
    - start-node-type: +
    + resource-version: string
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - start-node-filter: - object[] - - -
    -
    - -
    - -
    - start-node-filter - - - -
    - -
    -
    -
    -
    - include-node-filter: - object[] - - -
    -
    - -
    - -
    - include-node-filter - - - -
    - -
    -
    -
    -
    - secondary-filter: +
    + relationship-list: object[] @@ -135588,7 +156718,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - secondary-filter + relationship @@ -135601,9 +156731,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    edge-tag-query-result: +

    flavors: object @@ -135611,11 +156741,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Collection of openstack flavors.

    + +
    -
    - tagged-inventory-item-list: +
    + flavor: object[] @@ -135625,7 +156759,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tagged-inventory-item-list + flavor @@ -135638,9 +156772,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    element-choice-set: +

    forwarder: object @@ -135649,49 +156783,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This is how we would capture constraints defining allowed sets of elements.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    +

    Entity describing a sequenced segment of forwarding path

      -
    • TO model-element (comprises element-choice-set, One2Many)
      • -
    • FROM constrained-element-set (is composed of element-choice-set)
    +
  • 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
    • -
    - element-choice-set-uuid: - string - - - -
    -
    -
    - -
    -
    -
    - element-choice-set-name: - string +
    + sequence: + integer
    +

    Unique ID of this segmentation

    -
    - cardinality: +
    + forwarder-role: string
    +

    ingress, intermediate, egress

    @@ -135703,30 +156829,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - model-elements: - object[] - - -
    -
    - -
    - -
    - model-element - - - -
    - -
    -
    -
    relationship-list: object[] @@ -135751,9 +156858,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    element-choice-sets: +

    forwarder-evc: object @@ -135761,78 +156868,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    forwarder object is an optional child object of the Configuration object.

    + +
      +
    • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    + +
    -
    - element-choice-set: - object[] +
    + 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

    -
    - element-choice-set - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    entitlement: - object - - - -

    -
    -
    -
    -

    Metadata for entitlement group.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - -
      -
    • FROM generic-vnf (is composed of entitlement)
      • -
    • FROM vce (is composed of entitlement)
    - -
    - -
    -
    -
    - group-uuid: +
    + ivlan: string -
    -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Internal VLAN.

    -
    - resource-uuid: +
    + svlan: string -
    -

    Unique ID of an entitlement resource.

    +

    SVLAN value for ingress of egress forwarder.

    +
    + +
    +
    +
    + cvlan: + string + + +
    +
    +

    CVLAN value for ingress of egress forwarder.

    @@ -135844,7 +156946,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Concurrency value

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    @@ -135873,9 +156975,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    entitlements: +

    forwarder-evcs: object @@ -135883,15 +156985,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Entitlements, keyed by group-uuid and resource-uuid, related to license management

    - -
    -
    - entitlement: +
    + forwarder-evc: object[] @@ -135901,7 +156999,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - entitlement + forwarder-evc @@ -135914,9 +157012,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    extra-properties: +

    forwarders: object @@ -135924,15 +157022,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Extra properties for inventory item for response list

    - -
    -
    - extra-property: +
    + forwarder: object[] @@ -135942,7 +157036,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - extra-property + forwarder @@ -135955,48 +157049,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    extra-property: - object - - - -

    -
    -
    - -
    -
    -
    - property-name: - string - - -
    -
    -
    - -
    -
    -
    - property-value: - string - - -
    -
    -
    - -
    -
    -
    -
    -
    -
    -
    -
    -

    flavor: +

    forwarding-path: object @@ -136005,155 +157060,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Openstack flavor.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    +

    Entity that describes the sequenced forwarding path between interfaces of services or resources

      -
    • FROM cloud-region (is composed of flavor)
      • -
    • FROM vserver
    +
  • 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
    • -
    - flavor-id: +
    + forwarding-path-id: string
    -

    Flavor id, expected to be unique across cloud-region.

    +

    Unique ID of this FP

    -
    - flavor-name: +
    + forwarding-path-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

    +

    Name of the FP

    -
    - flavor-swap: +
    + resource-version: string
    -

    amount of swap space allocation

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - flavor-is-public: - boolean - - -
    -
    -

    whether flavor is available to all users or private to the tenant it was created in.

    -
    - -
    -
    -
    - flavor-selflink: +
    + selflink: string -
    -

    URL to endpoint where AAI can get more details

    +

    the self link for this FP

    -
    - flavor-disabled: - boolean +
    + relationship-list: + object[]
    -

    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 + + + +
    + +
    +
    -
    - relationship-list: +
    + forwarders: object[] @@ -136163,7 +157154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + forwarder @@ -136176,9 +157167,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    flavors: +

    forwarding-paths: object @@ -136186,15 +157177,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of openstack flavors.

    - -
    -
    - flavor: +
    + forwarding-path: object[] @@ -136204,7 +157191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - flavor + forwarding-path @@ -136229,31 +157216,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General purpose VNF

    -
    Default Delete Scope
    -

    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)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO entitlement (comprises generic-vnf, One2Many)
      • -
    • TO license (comprises generic-vnf, One2Many)
      • -
    • FROM virtual-data-center
      • -
    • FROM logical-link
      • -
    • FROM allotted-resource
    +
  • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • +
  • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
    • +
  • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • +
  • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
    • @@ -136991,13 +157977,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack group-assignment used to store exclusivity groups (EG).

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO tenant (Many2Many)
      • -
    • TO pserver (One2Many)
      • -
    • FROM cloud-region (is composed of group-assignment)
    +
  • 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)
    • @@ -137131,6 +158115,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -137143,13 +158270,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack image.

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO metadatum (comprises image, Many2Many)
      • -
    • FROM cloud-region (is composed of image)
      • -
    • FROM vserver
    +
  • 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
    • @@ -137467,18 +158594,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General mechanism for grouping instances

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO model (Many2Many)
      • -
    • FROM l-interface
      • -
    • FROM l3-interface-ipv4-address-list
      • -
    • FROM l3-interface-ipv6-address-list
      • -
    • FROM pnf
      • -
    • FROM allotted-resource
      • -
    • FROM generic-vnf
      • -
    • FROM service-instance
    +
  • TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • @@ -137776,7 +158901,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + aai-internal @@ -138032,12 +159157,11 @@ 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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO vig-server (comprises ipsec-configuration, One2Many)
      • -
    • FROM generic-vnf
    +
  • 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
    • @@ -138440,23 +159564,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical interfaces, e.g., a vnic.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
      • -
    • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
      • -
    • TO l-interface (comprises l-interface, One2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • TO vlan (comprises l-interface, Many2Many)
      • -
    • TO sriov-vf (comprises l-interface, One2One)
      • -
    • FROM generic-vnf (is composed of l-interface)
      • -
    • FROM lag-interface (is composed of l-interface)
      • -
    • FROM newvce (is composed of l-interface)
      • -
    • FROM p-interface (is composed of l-interface)
      • -
    • FROM vserver (is composed of l-interface)
      • -
    • FROM l-interface (is composed of l-interface)
    +
  • TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • +
  • TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • +
  • TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • +
  • TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
    • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -138784,15 +159908,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM l-interface (is composed of l3-interface-ipv4-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv4-address-list)
    +
  • 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)
    • @@ -138931,15 +160053,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM l-interface (is composed of l3-interface-ipv6-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv6-address-list)
    +
  • 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)
    • @@ -139078,25 +160198,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Generic network definition

    -
    Default Delete Scope
    -

    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
      • -
    • FROM tenant
      • -
    • FROM vf-module
      • -
    • FROM allotted-resource
    +
  • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • +
  • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • +
  • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • +
  • FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
    • @@ -139549,18 +160668,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Link aggregate interface

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO logical-link (Many2Many)
      • -
    • TO lag-link (Many2Many)
      • -
    • TO p-interface (Many2Many)
      • -
    • TO l-interface (comprises lag-interface, Many2Many)
      • -
    • FROM generic-vnf (is composed of lag-interface)
      • -
    • FROM pserver (is composed of lag-interface)
      • -
    • FROM pnf (is composed of lag-interface)
      • -
    • FROM vpls-pe (is composed of lag-interface)
    +
  • TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
    • +
  • TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • +
  • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • +
  • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • +
  • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
    • @@ -139772,12 +160891,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    LAG links can connect lag-interfaces

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM lag-interface
      • -
    • FROM logical-link
    +
  • 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)
    • @@ -139885,12 +161002,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for license group.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM generic-vnf (is composed of license)
      • -
    • FROM vce (is composed of license)
    +
  • TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • @@ -139958,9 +161073,119 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    +
    +

    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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    -

    licenses: +

    lines-of-business: object @@ -139969,14 +161194,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

    +

    Collection of lines-of-business

    -
    - license: +
    + line-of-business: object[] @@ -139986,7 +161211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - license + line-of-business @@ -140011,24 +161236,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical links generally connect l-interfaces but are used to express logical connectivity between two points

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO lag-link (Many2Many)
      • -
    • TO pnf (Many2Many)
      • -
    • TO logical-link (One2Many)
      • -
    • TO generic-vnf (Many2Many)
      • -
    • TO pserver (Many2Many)
      • -
    • TO cloud-region (Many2Many)
      • -
    • TO vpn-binding (Many2Many)
      • -
    • FROM l-interface
      • -
    • FROM lag-interface
      • -
    • FROM p-interface
      • -
    • FROM service-instance
      • -
    • FROM virtual-data-center
      • -
    • FROM vlan
      • -
    • FROM logical-link
    +
  • TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • +
  • TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
    • +
  • TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • +
  • TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
    • +
  • TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • @@ -140341,8 +161564,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

    @@ -140384,14 +161605,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Key/value pairs

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM image (is composed of metadatum)
      • -
    • FROM model-ver (is composed of metadatum)
      • -
    • FROM service-instance (is composed of metadatum)
      • -
    • FROM connector (is composed of metadatum)
    +
  • TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
    • +
  • TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
    • +
  • TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • @@ -140449,14 +161668,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO model-ver (comprises model, One2Many)
      • -
    • FROM named-query
      • -
    • FROM named-query-element
      • -
    • FROM instance-group
    +
  • 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
    • @@ -140659,12 +161879,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO constrained-element-set (comprises model-constraint, One2Many)
      • -
    • FROM model-element (is composed of model-constraint)
    +
  • 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
    • @@ -140779,17 +161998,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Defines how other models combine to make up a higher-level model.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO model-ver (Many2One)
      • -
    • TO model-element (comprises model-element, One2Many)
      • -
    • TO model-constraint (comprises model-element, One2Many)
      • -
    • TO constrained-element-set (comprises model-element, One2Many)
      • -
    • FROM model-ver (is composed of model-element)
      • -
    • FROM element-choice-set (is composed of model-element)
      • -
    • FROM model-element (is composed of model-element)
    +
  • 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
    • @@ -140969,14 +162187,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO model-element (comprises model-ver, One2Many)
      • -
    • TO metadatum (comprises model-ver, One2Many)
      • -
    • FROM model (is composed of model-ver)
      • -
    • FROM model-element
    +
  • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
    • +
  • MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
    • @@ -141198,11 +162416,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - +
      -
    • FROM vlan
    +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
    • @@ -141373,12 +162589,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO model (One2Many)
      • -
    • TO named-query-element (comprises named-query, One2One)
    +
  • 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
    • @@ -141509,16 +162725,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO named-query-element (comprises named-query-element, Many2Many)
      • -
    • TO model (Many2One)
      • -
    • TO property-constraint (comprises named-query-element, One2Many)
      • -
    • TO related-lookup (comprises named-query-element, One2Many)
      • -
    • FROM named-query (is composed of named-query-element)
      • -
    • FROM named-query-element (is composed of named-query-element)
    +
  • 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
    • @@ -142130,12 +163345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - +
      -
    • FROM l3-network
      • -
    • FROM allotted-resource
    +
  • 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)
    • @@ -142226,11 +163439,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Network profile populated by SDN-GP for SNMP

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM generic-vnf
    +
  • TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • @@ -142350,11 +163561,10 @@ 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.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO l-interface (comprises newvce, Many2Many)
    +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • NEWVCE is DELETED when these are DELETED L-INTERFACE
    • @@ -142918,13 +164128,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.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of oam-network)
    +
  • 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)
    • @@ -143070,6 +164278,182 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -143233,6 +164617,129 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +
    +

    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: @@ -143245,17 +164752,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Physical interface (e.g., nic)

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO l-interface (comprises p-interface, Many2Many)
      • -
    • 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 vpls-pe (is composed of p-interface)
    +
  • TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
    • +
  • TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    • +
  • TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • +
  • FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • +
  • P-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • +
  • P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
    • @@ -143479,11 +164986,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical connections, typically between p-interfaces

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM p-interface
    +
  • FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    • @@ -143651,6 +165156,116 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -143663,17 +165278,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    PNF represents a physical network function. typically equipment used in the D1 world.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO p-interface (comprises pnf, Many2Many)
      • -
    • TO lag-interface (comprises pnf, One2Many)
      • -
    • TO complex (Many2One)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO zone (Many2One)
      • -
    • FROM logical-link
      • -
    • FROM service-instance
    +
  • TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • +
  • PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    • @@ -144061,12 +165675,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Used to capture the network interfaces of this VCE

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO cvlan-tag (comprises port-group, Many2Many)
      • -
    • FROM vce (is composed of port-group)
    +
  • 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
    • @@ -144287,6 +165900,116 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -144342,11 +166065,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • FROM named-query-element (is composed of property-constraint)
    +
  • TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • @@ -144464,20 +166185,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO complex (Many2One)
      • -
    • TO cloud-region (Many2One)
      • -
    • TO availability-zone (Many2One)
      • -
    • TO lag-interface (comprises pserver, Many2Many)
      • -
    • TO p-interface (comprises pserver, Many2Many)
      • -
    • TO zone (Many2One)
      • -
    • FROM generic-vnf
      • -
    • FROM group-assignment
      • -
    • FROM vserver
      • -
    • FROM logical-link
    +
  • 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
    • @@ -144962,11 +166684,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • FROM named-query-element (is composed of related-lookup)
    +
  • TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • @@ -145210,26 +166930,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    -
    - -
    - related-to-property: - object[] - - -
    -
    - -
    - -
    - related-to-property - - - -
    -
    @@ -145509,11 +167209,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack route table reference.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM l3-network
    +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • @@ -145634,11 +167332,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Route target information

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • FROM vpn-binding (is composed of route-target)
    +
  • TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • @@ -145758,12 +167454,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    - +
      -
    • TO site-pair (comprises routing-instance, Many2Many)
      • -
    • FROM site-pair-set (is composed of routing-instance)
    +
  • 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
    • @@ -146206,11 +167901,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack segmentation assignment.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM l3-network (is composed of segmentation-assignment)
    +
  • TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • @@ -146318,8 +168011,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    @@ -146464,12 +168155,11 @@ 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.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

      -
    • FROM availability-zone
      • -
    • FROM oam-network
    +
  • 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
    • @@ -146670,26 +168360,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Instance of a service

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO cvlan-tag (Many2Many)
      • -
    • TO pnf (One2Many)
      • -
    • TO connector (Many2Many)
      • -
    • TO metadatum (comprises service-instance, Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • TO vlan (One2Many)
      • -
    • TO service-instance (One2Many)
      • -
    • TO ctag-assignment (One2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO allotted-resource (comprises service-instance, Many2Many)
      • -
    • TO allotted-resource (Many2Many)
      • -
    • FROM generic-vnf
      • -
    • FROM l3-network
      • -
    • FROM service-subscription (is composed of service-instance)
      • -
    • FROM vce
      • -
    • FROM service-instance
    +
  • TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • +
  • TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • +
  • TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
    • +
  • TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    • +
  • TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
    • +
  • TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • +
  • TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
    • +
  • TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
    • +
  • TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
    • +
  • SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -147017,13 +168707,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Object that group service instances.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO service-instance (comprises service-subscription, Many2Many)
      • -
    • FROM customer (is composed of service-subscription)
      • -
    • FROM tenant
    +
  • 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
    • @@ -147203,12 +168892,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    - +
      -
    • TO class-of-service (comprises site-pair, Many2Many)
      • -
    • FROM routing-instance (is composed of site-pair)
    +
  • 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
    • @@ -147355,12 +169043,11 @@ 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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO routing-instance (comprises site-pair-set, Many2Many)
      • -
    • FROM generic-vnf
    +
  • 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
    • @@ -147529,12 +169216,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack snapshot

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM cloud-region (is composed of snapshot)
      • -
    • FROM vserver
    +
  • TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
    • @@ -147738,6 +169423,117 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -147750,11 +169546,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)

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM l-interface (is composed of sriov-vf)
    +
  • TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • @@ -148044,13 +169838,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    - +
      -
    • FROM l3-interface-ipv4-address-list
      • -
    • FROM l3-interface-ipv6-address-list
      • -
    • FROM l3-network (is composed of subnet)
    +
  • TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
    • @@ -148311,16 +170104,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack tenant

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO l3-network (Many2Many)
      • -
    • TO service-subscription (Many2Many)
      • -
    • TO vserver (comprises tenant, One2Many)
      • -
    • FROM cloud-region (is composed of tenant)
      • -
    • FROM group-assignment
      • -
    • FROM volume-group
    +
  • 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
    • @@ -148461,11 +170253,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM allotted-resource (is composed of tunnel-xconnect)
    +
  • TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    • @@ -148748,17 +170538,16 @@ 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.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO availability-zone (Many2Many)
      • -
    • TO complex (Many2Many)
      • -
    • TO port-group (comprises vce, Many2Many)
      • -
    • TO vserver (Many2Many)
      • -
    • TO service-instance (Many2Many)
      • -
    • TO entitlement (comprises vce, One2Many)
      • -
    • TO license (comprises vce, One2Many)
    +
  • 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
    • @@ -149132,15 +170921,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    a deployment unit of VNFCs

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO volume-group (One2One)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO vnfc (One2Many)
      • -
    • FROM vserver
      • -
    • FROM generic-vnf (is composed of vf-module)
    +
  • TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • +
  • TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
    • +
  • TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
    • +
  • VF-MODULE cannot be deleted if linked to VNFC
    • @@ -149404,11 +171192,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

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM ipsec-configuration (is composed of vig-server)
    +
  • TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
    • @@ -149524,6 +171310,294 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -149536,13 +171610,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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO generic-vnf (Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • FROM connector
    +
  • 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)
    • @@ -149663,17 +171735,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Definition of vlan

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
      • -
    • TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
      • -
    • TO multicast-configuration (Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • FROM l-interface (is composed of vlan)
      • -
    • FROM service-instance
      • -
    • FROM allotted-resource
    +
  • 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
    • @@ -149959,11 +172031,10 @@ 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.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

      -
    • FROM generic-vnf
    +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
    • @@ -150120,13 +172191,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - +
      -
    • FROM vserver
      • -
    • FROM vf-module
      • -
    • FROM generic-vnf
    +
  • TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • @@ -150332,11 +172401,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Ephemeral Block storage volume.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • FROM vserver (is composed of volume)
    +
  • FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
    • @@ -150416,15 +172483,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persistent block-level storage.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO complex (Many2Many)
      • -
    • TO tenant (Many2Many)
      • -
    • FROM cloud-region (is composed of volume-group)
      • -
    • FROM vf-module
      • -
    • FROM generic-vnf
    +
  • 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)
    • @@ -150647,14 +172712,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPLS Provider Edge routers.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO complex (Many2Many)
      • -
    • TO ctag-pool (Many2Many)
      • -
    • TO p-interface (comprises vpls-pe, Many2Many)
      • -
    • TO lag-interface (comprises vpls-pe, Many2Many)
    +
  • 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
    • @@ -150849,13 +172913,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPN binding

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO route-target (comprises vpn-binding, One2Many)
      • -
    • FROM l3-network
      • -
    • FROM logical-link
    +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • +
  • VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
    • +
  • VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
    • @@ -151028,21 +173092,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual Servers, aka virtual machine or VM.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO flavor (Many2One)
      • -
    • TO image (Many2One)
      • -
    • TO l-interface (comprises vserver, Many2Many)
      • -
    • TO pserver (Many2One)
      • -
    • TO volume (comprises vserver, Many2Many)
      • -
    • TO vnfc (Many2Many)
      • -
    • TO snapshot (One2One)
      • -
    • TO vf-module (Many2One)
      • -
    • FROM generic-vnf
      • -
    • FROM tenant (is composed of vserver)
      • -
    • FROM vce
    +
  • 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
    • @@ -151264,14 +173328,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    A zone is a grouping of assets in a location homing to the same connections into the CBB

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO complex (Many2One)
      • -
    • FROM cloud-region
      • -
    • FROM pserver
      • -
    • FROM pnf
    +
  • 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)
    • diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html index 869ad93d..06cb9d46 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v11.html @@ -1,4 +1,3 @@ - @@ -15,8 +14,11 @@

    Active and Available Inventory REST API.

    -

    Version: v11

    -

    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
    +

    Version: v12

    +


    +[Differences versus the previous schema version](apidocs/aai_swagger_v11.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.

    @@ -62,6 +64,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    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
    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
    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
    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    create or update an existing esr-system-info

    +
    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    update an existing esr-system-info
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    create or update an existing pserver

    +
    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    update an existing pserver
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    -

    Tag: ExternalSystem

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    OperationDescription
    GET /external-system/esr-ems-list

    returns esr-ems-list

    -
    GET /external-system/esr-ems-list/esr-ems/{ems-id}

    returns esr-ems

    -
    PUT /external-system/esr-ems-list/esr-ems/{ems-id}

    create or update an existing esr-ems

    -
    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}

    delete an existing esr-ems

    -
    GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list

    returns esr-system-info-list

    -
    GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    returns esr-system-info

    -
    PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    create or update an existing esr-system-info

    -
    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    delete an existing esr-system-info

    -
    PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    see node definition for valid relationships

    -
    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    delete an existing relationship

    -
    PUT /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

    see node definition for valid relationships

    -
    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

    delete an existing relationship

    -
    GET /external-system/esr-thirdparty-sdnc-list

    returns esr-thirdparty-sdnc-list

    -
    GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

    returns esr-thirdparty-sdnc

    -
    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

    create or update an existing esr-thirdparty-sdnc

    -
    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

    delete an existing esr-thirdparty-sdnc

    -
    GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list

    returns esr-system-info-list

    -
    GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    returns esr-system-info

    -
    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    create or update an existing esr-system-info

    -
    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    delete an existing esr-system-info

    -
    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    see node definition for valid relationships

    -
    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    delete an existing relationship

    -
    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

    see node definition for valid relationships

    -
    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

    delete an existing relationship

    -
    GET /external-system/esr-vnfm-list

    returns esr-vnfm-list

    -
    GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

    returns esr-vnfm

    -
    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

    create or update an existing esr-vnfm

    -
    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

    delete an existing esr-vnfm

    -
    GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list

    returns esr-system-info-list

    -
    GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    returns esr-system-info

    -
    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    create or update an existing esr-system-info

    -
    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    delete an existing esr-system-info

    -
    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    see node definition for valid relationships

    -
    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    delete an existing relationship

    -
    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

    see node definition for valid relationships

    -
    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

    delete an existing relationship

    -
    - -

    Tag: Business

    @@ -1540,6 +1573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1560,6 +1598,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1590,6 +1633,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1620,6 +1668,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1650,6 +1703,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1670,6 +1728,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1700,6 +1763,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1730,6 +1798,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1760,6 +1833,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1790,6 +1868,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1820,6 +1903,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1850,6 +1938,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1894,6 +1987,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1914,6 +2012,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1934,6 +2037,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1954,6 +2062,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1974,6 +2087,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1994,6 +2112,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2014,6 +2137,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2084,6 +2212,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2104,6 +2237,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2124,6 +2262,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2144,6 +2287,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2194,6 +2342,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2224,6 +2377,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2254,6 +2412,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2285,6 +2448,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2318,6 +2546,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2348,6 +2581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2363,6 +2601,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2388,6 +2631,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2428,6 +2676,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2458,6 +2711,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2473,6 +2731,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2498,6 +2761,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2538,6 +2806,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2558,6 +2831,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2573,6 +2851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2598,6 +2881,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2638,6 +2926,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2668,6 +2961,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2683,6 +2981,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2708,6 +3011,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2758,6 +3066,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2798,6 +3111,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2828,6 +3146,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2858,6 +3181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2888,6 +3216,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2918,6 +3251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2938,6 +3276,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2978,6 +3321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3008,6 +3356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3028,6 +3381,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3068,6 +3426,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3098,6 +3461,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3128,6 +3496,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3158,6 +3531,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3188,6 +3566,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3208,6 +3591,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3223,6 +3611,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3248,6 +3641,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3288,6 +3686,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3318,6 +3721,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3333,6 +3741,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3358,6 +3771,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3408,6 +3826,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3438,6 +3861,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3458,6 +3886,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3478,6 +3911,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3493,6 +3931,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3518,6 +3961,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3558,6 +4006,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3588,6 +4041,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3603,6 +4061,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3628,6 +4091,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3678,6 +4146,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3698,6 +4171,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3713,6 +4191,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3738,6 +4221,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3778,6 +4266,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3808,6 +4301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3823,6 +4321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3848,6 +4351,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3898,6 +4406,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3938,6 +4451,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3968,6 +4486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3998,6 +4521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4028,6 +4556,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4048,6 +4581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4088,6 +4626,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4108,6 +4651,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4138,6 +4686,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4168,6 +4721,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4188,6 +4746,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4238,6 +4801,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4253,6 +4821,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4278,6 +4851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4318,6 +4896,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4338,6 +4921,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4358,6 +4946,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4373,6 +4966,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4398,6 +4996,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4438,6 +5041,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4468,6 +5076,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4483,6 +5096,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4508,6 +5126,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4558,6 +5181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4578,6 +5206,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4593,6 +5226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4618,6 +5256,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4658,6 +5301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4688,6 +5336,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4703,6 +5356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4728,6 +5386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4778,6 +5441,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4818,6 +5486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4848,6 +5521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4878,6 +5556,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4940,7 +5623,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /connectors + /connectors
    @@ -5095,7 +5778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /connector + /connector
    @@ -5142,7 +5825,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    connector object that needs to be created or updated

    +

    connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)

    @@ -5213,22 +5896,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing connector
    -

    DELETE /business/connectors/connector/{resource-instance-id}

    +
    update an existing connector
    +

    PATCH /business/connectors/connector/{resource-instance-id}

    Tags: Business
    -

    delete an existing connector

    +

    update an existing connector

    application/json application/xml

    +
    +
    +

    connector object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /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
    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
    PUT /business/customers/customer/{global-customer-id}

    create or update an existing customer

    +
    PATCH /business/customers/customer/{global-customer-id}

    update an existing customer
    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
    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
    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
    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
    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
    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
    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
    PUT /business/platforms/platform/{platform-name}

    create or update an existing platform

    +
    PATCH /business/platforms/platform/{platform-name}

    update an existing platform
    PUT /business/projects/project/{project-name}

    create or update an existing project

    +
    PATCH /business/projects/project/{project-name}

    update an existing project
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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}/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/generic-vnfs

    returns generic-vnfs

    @@ -2298,6 +2521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/newvces/newvce/{vnf-id2}

    create or update an existing newvce

    +
    PATCH /network/newvces/newvce/{vnf-id2}

    update an existing newvce
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/pnfs/pnf/{pnf-name}

    create or update an existing pnf

    +
    PATCH /network/pnfs/pnf/{pnf-name}

    update an existing pnf
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/vces/vce/{vnf-id}

    create or update an existing vce

    +
    PATCH /network/vces/vce/{vnf-id}

    update an existing vce
    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
    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
    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
    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
    PUT /network/vnfcs/vnfc/{vnfc-name}

    create or update an existing vnfc

    +
    PATCH /network/vnfcs/vnfc/{vnfc-name}

    update an existing vnfc
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/zones/zone/{zone-id}

    create or update an existing zone

    +
    PATCH /network/zones/zone/{zone-id}

    update an existing zone
    @@ -5258,22 +5953,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -5305,19 +5984,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns metadata
    -

    GET /business/connectors/connector/{resource-instance-id}/metadata

    +
    delete an existing connector
    +

    DELETE /business/connectors/connector/{resource-instance-id}

    Tags: Business
    -

    returns metadata

    +

    delete an existing connector

    +
    + +

    application/json application/xml +

    +
    @@ -5348,55 +6032,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - @@ -5415,29 +6055,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadata -
    -
    -
    - -
    default @@ -5460,17 +6077,172 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadatum
    -

    GET /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

    +
    returns metadata
    +

    GET /business/connectors/connector/{resource-instance-id}/metadata

    Tags: Business
    -

    returns metadatum

    +

    returns metadata

    + +
    +
    +
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version + resource-version -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    resource-version for concurrency

    		 query @@ -5404,6 +6043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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

    @@ -5602,7 +6374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadatum
    @@ -5649,7 +6421,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json)

    @@ -5734,6 +6506,110 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -5861,7 +6737,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)

    @@ -6044,7 +6920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /customers + /customers
    @@ -6169,7 +7045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /customer + /customer
    @@ -6216,7 +7092,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    customer object that needs to be created or updated

    +

    customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)

    @@ -6287,16 +7163,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing customer
    -

    DELETE /business/customers/customer/{global-customer-id}

    +
    update an existing customer
    +

    PATCH /business/customers/customer/{global-customer-id}

    Tags: Business
    -

    delete an existing customer

    +

    update an existing customer

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    customer object that needs to be 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

    @@ -6398,7 +7363,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)

    @@ -6642,7 +7607,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-subscriptions + /service-subscriptions
    @@ -6783,7 +7748,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-subscription + /service-subscription
    @@ -6830,7 +7795,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-subscription object that needs to be created or updated

    +

    service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

    @@ -6917,22 +7882,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing service-subscription
    -

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    +
    update an existing service-subscription
    +

    PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    delete an existing service-subscription

    +

    update an existing service-subscription

    application/json application/xml

    +
    +
    +

    service-subscription object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /service-subscription +
    +
    +
    @@ -6978,22 +7955,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -7025,35 +7986,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    +
    delete an existing service-subscription
    +

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    see node definition for valid relationships

    +

    delete an existing service-subscription

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -7099,91 +8048,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /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 + resource-version -

    Value defined by orchestration to identify this service across ECOMP.

    +

    resource-version for concurrency

    		pathquery string @@ -7223,19 +8095,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns service-instances
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances

    +
    see node definition for valid relationships
    +

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    Tags: Business
    -

    returns service-instances

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -7280,36 +8169,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -     		query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -     		query - string - - -
    @@ -7319,29 +8178,240 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /service-instances -
    -
    -
    - -
    +
    + 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 @@ -7628,7 +8698,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-instance + /service-instance
    @@ -7675,7 +8745,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-instance object that needs to be created or updated

    +

    service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

    @@ -7778,22 +8848,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing service-instance

    +

    update an existing service-instance

    application/json application/xml

    +
    +
    +

    service-instance object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /service-instance +
    +
    +
    @@ -7855,22 +8937,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -8166,7 +9357,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /allotted-resources + /allotted-resources
    @@ -8534,7 +9725,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /allotted-resource + /allotted-resource
    @@ -8581,7 +9772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    allotted-resource object that needs to be created or updated

    +

    allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

    @@ -8699,6 +9890,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing allotted-resource
    +

    PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -8859,7 +10187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

    @@ -9442,7 +10770,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tunnel-xconnects + /tunnel-xconnects
    @@ -9826,7 +11154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tunnel-xconnect + /tunnel-xconnect
    @@ -9873,7 +11201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    tunnel-xconnect object that needs to be created or updated

    +

    tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

    @@ -10008,22 +11336,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing tunnel-xconnect

    +

    update an existing tunnel-xconnect

    application/json application/xml

    +
    +
    +

    tunnel-xconnect object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /tunnel-xconnect +
    +
    +
    @@ -10117,22 +11457,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -10164,35 +11488,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing tunnel-xconnect

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -10286,6 +11598,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -10318,22 +11646,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -10458,19 +11798,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadata
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata

    +
    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
    -

    returns metadata

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -10533,167 +11878,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -10705,29 +11917,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadata -
    -
    -
    - -
    default @@ -10750,17 +11939,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 metadatum

    +

    returns metadata

    @@ -10823,21 +12012,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - -
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -     		query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -     		query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -     		query - string - - -
    - environment-context - -

    This field will store the environment context assigned to the service-instance.

    -     		query - string - - -
    - workload-context - -

    This field will store the workload context assigned to the service-instance.

    -     		query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -     		query - string - - -
    - service-instance-location-id + id -

    An identifier that customers assign to the location where this service is being used.

    +

    Allotted Resource id UUID assigned to this instance.

    		querypath string +
    - orchestration-status + id -

    Orchestration status of this service.

    +

    Allotted Resource id UUID assigned to this instance.

    		querypath string +
    - metaname - - path - string - - - -
    subscriber-name @@ -11029,7 +12203,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadata
    @@ -11058,35 +12232,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    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}

    +
    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
    -

    create or update an existing metadatum

    +

    returns metadatum

    -
    - -

    application/json application/xml -

    -
    -
    -

    metadatum object that needs to be created or updated

    -

    -
    -
    -
    -
    - /metadatum -
    -
    -
    -
    @@ -11162,6 +12319,171 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + subscriber-name + +

    Subscriber name, an alternate way to retrieve a customer.

    +     		query + string + + +
    + subscriber-type + +

    Subscriber type, a way to provide VID with only the INFRA customers.

    +     		query + string + + +
    + service-instance-name + +

    This field will store a name assigned to the service-instance.

    +     		query + string + + +
    + environment-context + +

    This field will store the environment context assigned to the service-instance.

    +     		query + string + + +
    + workload-context + +

    This field will store the workload context assigned to the service-instance.

    +     		query + string + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + model-version-id + +

    the ASDC model version for this resource or service model.

    +     		query + string + + +
    + widget-model-id + +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +     		query + string + + +
    + widget-model-version + +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + string + + +
    + service-instance-location-id + +

    An identifier that customers assign to the location where this service is being used.

    +     		query + string + + +
    + orchestration-status + +

    Orchestration status of this service.

    +     		query + string + + +
    @@ -11171,6 +12493,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /metadatum +
    +
    +
    + +
    default @@ -11194,22 +12539,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing metadatum

    +

    create or update an existing metadatum

    application/json application/xml

    +
    +
    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)

    +

    +
    +
    +
    +
    + /metadatum +
    +
    +
    @@ -11286,22 +12643,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -11333,17 +12674,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing metadatum

    @@ -11352,13 +12693,289 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    metadatum object that needs to be created or updated.

    - /relationship + /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/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

    +

    +
    +
    +
    +
    + /relationship
    @@ -11599,7 +13216,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lines-of-business + /lines-of-business
    @@ -11694,7 +13311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /line-of-business + /line-of-business
    @@ -11741,7 +13358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    line-of-business object that needs to be created or updated

    +

    line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)

    @@ -11811,6 +13428,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -11923,7 +13629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)

    @@ -12106,7 +13812,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /owning-entities + /owning-entities
    @@ -12201,7 +13907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /owning-entity + /owning-entity
    @@ -12248,7 +13954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    owning-entity object that needs to be created or updated

    +

    owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)

    @@ -12318,6 +14024,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -12430,7 +14225,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)

    @@ -12613,7 +14408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /platforms + /platforms
    @@ -12708,7 +14503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /platform + /platform
    @@ -12755,7 +14550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    platform object that needs to be created or updated

    +

    platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)

    @@ -12825,6 +14620,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -12937,7 +14821,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)

    @@ -13120,7 +15004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /projects + /projects
    @@ -13215,7 +15099,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /project + /project
    @@ -13262,7 +15146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    project object that needs to be created or updated

    +

    project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)

    @@ -13332,6 +15216,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -13444,7 +15417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)

    @@ -13627,7 +15600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cloud-regions + /cloud-regions
    @@ -13768,7 +15741,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cloud-region + /cloud-region
    @@ -13815,7 +15788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cloud-region object that needs to be created or updated

    +

    cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)

    @@ -13902,16 +15875,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing cloud-region
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

    +
    update an existing cloud-region
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

    Tags: CloudInfrastructure
    -

    delete an existing cloud-region

    +

    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

    @@ -14123,7 +16201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /availability-zones + /availability-zones
    @@ -14280,7 +16358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /availability-zone + /availability-zone
    @@ -14327,7 +16405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    availability-zone object that needs to be created or updated

    +

    availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

    @@ -14429,6 +16507,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -14573,7 +16772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

    @@ -14897,7 +17096,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /dvs-switches + /dvs-switches
    @@ -15069,7 +17268,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /dvs-switch + /dvs-switch
    @@ -15116,7 +17315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    dvs-switch object that needs to be created or updated

    +

    dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

    @@ -15219,22 +17418,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing dvs-switch
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

    +
    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
    -

    delete an existing dvs-switch

    +

    update an existing dvs-switch

    application/json application/xml

    +
    +
    +

    dvs-switch object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /dvs-switch +
    +
    +
    @@ -15296,22 +17507,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -15343,35 +17538,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing dvs-switch

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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 + + + +
    + 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/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -15686,7 +18006,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info-list + /esr-system-info-list
    @@ -15873,7 +18193,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info + /esr-system-info
    @@ -15920,7 +18240,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-system-info object that needs to be created or updated

    +

    esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)

    @@ -16022,6 +18342,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing esr-system-info
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    update an existing esr-system-info

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    esr-system-info object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /esr-system-info +
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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 + + + +
    + esr-system-info-id + +

    Unique ID of esr system info.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -16166,7 +18607,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)

    @@ -16490,7 +18931,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /flavors + /flavors
    @@ -16662,7 +19103,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /flavor + /flavor
    @@ -16709,7 +19150,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    flavor object that needs to be created or updated

    +

    flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -16812,16 +19253,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing flavor
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    +
    update an existing flavor
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    Tags: CloudInfrastructure
    -

    delete an existing flavor

    +

    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

    @@ -16955,7 +19517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -17279,7 +19841,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignments + /group-assignments
    @@ -17466,7 +20028,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignment + /group-assignment
    @@ -17513,7 +20075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    group-assignment object that needs to be created or updated

    +

    group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    @@ -17616,22 +20178,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing group-assignment
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    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
    -

    delete an existing group-assignment

    +

    update an existing group-assignment

    application/json application/xml

    +
    +
    +

    group-assignment object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /group-assignment +
    +
    +
    @@ -17693,22 +20267,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -17740,35 +20298,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing group-assignment

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -17830,107 +20376,244 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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 + resource-version -

    Group id, expected to be unique across cloud-region.

    +

    resource-version for concurrency

    		pathquery + 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/v11/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 @@ -18083,7 +20766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /images + /images
    @@ -18300,7 +20983,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /image + /image
    @@ -18347,7 +21030,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    image object that needs to be created or updated

    +

    image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

    @@ -18450,22 +21133,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing image
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    +
    update an existing image
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    Tags: CloudInfrastructure
    -

    delete an existing image

    +

    update an existing image

    application/json application/xml

    +
    +
    +

    image object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /image +
    +
    +
    @@ -18527,22 +21222,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -18763,7 +21567,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /metadata
    @@ -18995,7 +21799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadatum
    @@ -19042,7 +21846,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

    @@ -19160,22 +21964,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing metadatum
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    +
    update an existing metadatum
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    Tags: CloudInfrastructure
    -

    delete an existing metadatum

    +

    update an existing metadatum

    application/json application/xml

    +
    +
    +

    metadatum object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /metadatum +
    +
    +
    @@ -19252,22 +22068,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -19299,35 +22099,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing metadatum

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -19389,89 +22177,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + metaname -

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -19484,12 +22194,242 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - image-id + resource-version -

    Image id, expected to be unique across cloud region

    +

    resource-version for concurrency

    		pathquery + 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/v11/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 @@ -19642,7 +22582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /oam-networks + /oam-networks
    @@ -19829,7 +22769,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /oam-network + /oam-network
    @@ -19876,7 +22816,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    oam-network object that needs to be created or updated

    +

    oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

    @@ -19979,22 +22919,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing oam-network
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

    +
    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
    -

    delete an existing oam-network

    +

    update an existing oam-network

    application/json application/xml

    +
    +
    +

    oam-network object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /oam-network +
    +
    +
    @@ -20056,22 +23008,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -20122,7 +23183,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

    @@ -20352,7 +23413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)

    @@ -20644,7 +23705,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /snapshots + /snapshots
    @@ -20876,7 +23937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /snapshot + /snapshot
    @@ -20923,7 +23984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    snapshot object that needs to be created or updated

    +

    snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    @@ -21026,141 +24087,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing snapshot
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    update an existing snapshot
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    delete an existing snapshot

    - -
    -
    - -

    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

    +

    update an existing snapshot

    @@ -21169,13 +24105,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

    +

    snapshot object that needs to be created or updated.

    - /relationship + /snapshot
    @@ -21271,17 +24207,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    +
    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 relationship

    +

    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/v11/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

    @@ -21493,7 +24675,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tenants + /tenants
    @@ -21680,7 +24862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tenant + /tenant
    @@ -21727,7 +24909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    tenant object that needs to be created or updated

    +

    tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    @@ -21830,22 +25012,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing tenant
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    update an existing tenant
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    delete an existing tenant

    +

    update an existing tenant

    application/json application/xml

    +
    +
    +

    tenant object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /tenant +
    +
    +
    @@ -21907,22 +25101,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -21954,35 +25132,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    +
    delete an existing tenant
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing tenant

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -22044,6 +25210,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -22076,22 +25258,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -22184,19 +25378,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vservers
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns vservers

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -22257,66 +25456,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -     		query - string - - -
    @@ -22326,29 +25465,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vservers -
    -
    -
    - -
    default @@ -22371,17 +25487,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vserver
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    returns vservers
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

    Tags: CloudInfrastructure
    -

    returns vserver

    +

    returns vservers

    @@ -22444,22 +25560,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -     		path - string - - - -
    cloud-type @@ -22520,79 +25620,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -22619,7 +25646,283 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vserver + /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
    @@ -22666,7 +25969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vserver object that needs to be created or updated

    +

    vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    @@ -22784,6 +26087,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vserver
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -23173,7 +26613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -23510,7 +26950,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -23557,7 +26997,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

    @@ -23691,6 +27131,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l-interface
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -24218,7 +27811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -24265,7 +27858,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -24415,6 +28008,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -24607,7 +28369,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -25284,7 +29046,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -25331,7 +29093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -25482,22 +29244,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -25607,22 +29381,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -25654,35 +29412,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -25792,6 +29538,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -25824,22 +29586,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -25980,35 +29754,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -26102,137 +29864,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/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 + l3-interface-ipv6-address -

    Name given to the interface

    +

    IP address

    		 path @@ -26274,17 +29911,311 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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
    -

    returns sriov-vfs

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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

    @@ -26583,7 +30514,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -26996,7 +30927,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -27043,7 +30974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -27194,22 +31125,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing sriov-vf
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing 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
    -

    delete an existing sriov-vf

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -27319,22 +31262,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -27366,35 +31293,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -27504,6 +31419,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -27536,22 +31467,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -27692,19 +31635,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -27799,180 +31747,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -27984,29 +31770,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -28029,17 +31792,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    returns vlans

    @@ -28134,22 +31897,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - tenant-context - -

    This field will store the tenant context.

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name + pci-id -

    Name of the network

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    cloud-type @@ -28328,36 +32075,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -28384,7 +32101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlans
    @@ -28413,35 +32130,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing vlan
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns vlan
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    create or update an existing vlan

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    vlan object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vlan -
    -
    -
    -
    @@ -28550,169 +32250,205 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing vlan
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-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 + cloud-type -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - cloud-region-id + owner-defined-type -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		pathquery string -
    - tenant-id + tenant-name -

    Unique id relative to the cloud-region.

    +

    Readable name of tenant

    		pathquery string -
    - vserver-id + tenant-context -

    Unique identifier for this vserver relative to its tenant

    +

    This field will store the tenant context.

    		pathquery string -
    - interface-name + vserver-name -

    Name given to the interface

    +

    Name of vserver

    		pathquery string -
    - vlan-interface + vserver-name2 -

    String that identifies the interface

    +

    Alternative name of vserver

    		pathquery string -
    - resource-version + prov-status -

    resource-version for concurrency

    +

    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 @@ -28720,7 +32456,540 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing vlan
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    create or update an existing vlan

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -29170,7 +33439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -29217,7 +33486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -29384,22 +33653,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + +
    @@ -29525,22 +33806,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -29572,35 +33837,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -29726,6 +33979,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -29758,22 +34027,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -29930,17 +34211,190 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    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

    @@ -30346,7 +34800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -30393,7 +34847,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -30560,22 +35014,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -30701,22 +35167,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -30748,35 +35198,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -30902,6 +35340,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -30934,22 +35388,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -31106,35 +35572,208 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -31451,7 +36090,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    @@ -31942,7 +36581,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volumes + /volumes
    @@ -32234,7 +36873,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volume + /volume
    @@ -32281,7 +36920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume object that needs to be created or updated

    +

    volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    @@ -32416,22 +37055,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing volume
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    update an existing volume
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    delete an existing volume

    +

    update an existing volume

    application/json application/xml

    +
    +
    +

    volume object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /volume +
    +
    +
    @@ -32525,22 +37176,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -32572,35 +37207,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +
    delete an existing volume
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing volume

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -32694,6 +37317,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -32726,22 +37365,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -32866,19 +37517,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vip-ipv4-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns vip-ipv4-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -32925,10 +37581,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -33023,29 +37636,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vip-ipv4-address-list -
    -
    -
    - -
    default @@ -33069,35 +37659,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing vip-ipv4-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    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
    -

    create or update an existing vip-ipv4-address-list

    +

    returns vip-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    -
    -

    vip-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vip-ipv4-address-list -
    -
    -
    -
    - vip-ipv4-address + tenant-id -

    IP address

    +

    Unique id relative to the cloud-region.

    		 path @@ -32941,77 +37597,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id + vserver-id -

    Neutron network id of the interface that address belongs to

    +

    Unique identifier for this vserver relative to its tenant

    		querypath string +
    - neutron-subnet-id + volume-id -

    Neutron id of subnet that address belongs to

    +

    Unique ID of block storage volume relative to the vserver.

    		querypath string +
    @@ -33158,6 +37731,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    +     		query + string + + +
    + neutron-subnet-id + +

    Neutron id of subnet that address belongs to

    +     		query + string + + +
    @@ -33167,6 +37815,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vip-ipv4-address-list +
    +
    +
    + +
    default @@ -33190,22 +37861,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing vip-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

    +
    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
    -

    delete an existing vip-ipv4-address-list

    +

    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/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /vip-ipv4-address-list +
    +
    +
    @@ -33267,22 +37950,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -33314,17 +37981,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing vip-ipv4-address-list

    @@ -33333,13 +38000,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

    +

    vip-ipv4-address-list object that needs to be created or updated.

    - /relationship + /vip-ipv4-address-list
    @@ -33435,17 +38102,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing vip-ipv4-address-list

    @@ -33513,6 +38180,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -33544,19 +38227,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vip-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    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
    -

    returns vip-ipv6-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -33603,7 +38303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vip-ipv6-address + vip-ipv4-address

    IP address

    @@ -33617,81 +38317,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -     		query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -     		query - string - - -
    @@ -33701,29 +38326,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vip-ipv6-address-list -
    -
    -
    - -
    default @@ -33746,35 +38348,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vip-ipv6-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    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
    -

    create or update an existing vip-ipv6-address-list

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    vip-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vip-ipv6-address-list -
    -
    -
    @@ -33822,7 +38412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv6-address + vip-ipv4-address

    IP address

    @@ -33868,23 +38458,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    delete an existing vip-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

    +
    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
    -

    delete an existing vip-ipv6-address-list

    +

    returns vip-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -33947,10 +38532,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -33970,6 +38614,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vip-ipv6-address-list +
    +
    +
    + +
    default @@ -33992,17 +38659,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing vip-ipv6-address-list

    @@ -34011,13 +38678,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

    +

    vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

    - /relationship + /vip-ipv6-address-list
    @@ -34113,23 +38780,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    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 +
    +
    +
    - resource-version + cloud-type -

    resource-version for concurrency

    +

    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 @@ -33958,7 +38603,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -34222,19 +38901,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns volume-groups
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

    +
    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
    -

    returns volume-groups

    +

    delete an existing vip-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -34281,25 +38965,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -34318,29 +39004,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /volume-groups -
    -
    -
    - -
    default @@ -34363,19 +39026,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns volume-group
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    +
    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
    -

    returns volume-group

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - cloud-type + vip-ipv6-address -

    Type of the cloud (e.g., openstack)

    +

    IP address

    		querypath string +
    - owner-defined-type + resource-version -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    resource-version for concurrency

    		 query @@ -34307,6 +38992,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -34422,10 +39102,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - volume-group-id + vip-ipv6-address -

    Unique ID of volume-group.

    +

    IP address

    		 path @@ -34436,79 +39116,113 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + @@ -34520,29 +39234,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /volume-group -
    -
    -
    - -
    default @@ -34565,36 +39256,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing volume-group
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    +
    returns volume-groups
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

    Tags: CloudInfrastructure
    -

    create or update an existing volume-group

    +

    returns volume-groups

    -
    - -

    application/json application/xml -

    -
    -
    -

    volume-group object that needs to be created or updated

    -

    -
    -
    -
    -
    - /volume-group -
    -
    -
    -
    - 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 + cloud-owner -

    Name of the volume group.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		querypath string +
    - heat-stack-id + cloud-region-id -

    Heat stack id corresponding to this volume-group

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - vnf-type + vip-ipv6-address -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    IP address

    		querypath string +
    @@ -34641,18 +39315,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -34664,6 +39352,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /volume-groups +
    +
    +
    + +
    default @@ -34687,23 +39398,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    delete an existing volume-group
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    +
    returns volume-group
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    delete an existing volume-group

    +

    returns volume-group

    -
    - -

    application/json application/xml -

    -
    - volume-group-id + cloud-type -

    Unique ID of volume-group.

    +

    Type of the cloud (e.g., openstack)

    		pathquery + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query string -
    @@ -34766,10 +39472,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -34789,6 +39554,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /volume-group +
    +
    +
    + +
    default @@ -34811,17 +39599,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing volume-group

    @@ -34830,13 +39618,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

    +

    volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    - /relationship + /volume-group
    @@ -34932,23 +39720,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    +
    update an existing volume-group
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    update an existing volume-group

    application/json application/xml

    +
    +
    +

    volume-group object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /volume-group +
    +
    +
    - resource-version + cloud-type -

    resource-version for concurrency

    +

    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 @@ -34777,7 +39543,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -35041,83 +39841,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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
    -

    returns complex

    +

    delete an existing volume-group

    +
    + +

    application/json application/xml +

    +
    @@ -35132,10 +39873,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -35200,29 +39944,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /complex -
    -
    -
    - -
    default @@ -35245,17 +39966,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing complex
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

    +
    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
    -

    create or update an existing complex

    +

    see node definition for valid relationships

    @@ -35264,13 +39985,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    complex object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    - /complex + /relationship
    @@ -35289,10 +40010,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + - + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -35148,40 +39889,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code + cloud-region-id -

    Data center code which can be an alternate way to identify a complex

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - complex-name + volume-group-id -

    Gamma complex name for LCP instance.

    +

    Unique ID of volume-group.

    		querypath string +
    - identity-url + resource-version -

    URL of the keystone identity service

    +

    resource-version for concurrency

    		 query @@ -35189,6 +39932,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    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 @@ -35334,17 +40087,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing complex
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

    +
    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 complex

    +

    delete an existing relationship

    @@ -35366,10 +40119,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -35382,12 +40135,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + cloud-region-id -

    resource-version for concurrency

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath + string + + + +
    + volume-group-id + +

    Unique ID of volume-group.

    +     		path string @@ -35427,95 +40196,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns ctag-pools
    -

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

    +
    returns complexes
    +

    GET /cloud-infrastructure/complexes

    Tags: CloudInfrastructure
    -

    returns ctag-pools

    +

    returns complexes

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -35539,7 +40232,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /ctag-pools + /complexes
    @@ -35567,17 +40260,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns ctag-pool
    -

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    returns complex
    +

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    returns ctag-pool

    +

    returns complex

    @@ -35608,38 +40301,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe - -

    The Target provider edge router

    -     		path - string - - - -
    - availability-zone-name - -

    Name of the availability zone

    -     		path - string - - - -
    data-center-code @@ -35711,7 +40372,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-pool + /complex
    @@ -35739,17 +40400,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing ctag-pool
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    create or update an existing complex
    +

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    create or update an existing ctag-pool

    +

    create or update an existing complex

    @@ -35758,13 +40419,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-pool object that needs to be created or updated

    +

    complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplex.json)

    - /ctag-pool + /complex
    @@ -35797,38 +40458,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe - -

    The Target provider edge router

    -     		path - string - - - -
    - availability-zone-name - -

    Name of the availability zone

    -     		path - string - - - -
    @@ -35860,17 +40489,753 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing ctag-pool
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    update an existing complex
    +

    PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    delete an existing ctag-pool

    +

    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/v11/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

    @@ -36004,7 +41369,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

    @@ -36234,7 +41599,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplex.json)

    @@ -36417,7 +41782,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-profiles + /network-profiles
    @@ -36512,7 +41877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-profile + /network-profile
    @@ -36559,7 +41924,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-profile object that needs to be created or updated

    +

    network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)

    @@ -36629,6 +41994,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing network-profile
    +

    PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -36741,7 +42195,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)

    @@ -36924,7 +42378,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pservers + /pservers
    @@ -37078,7 +42532,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pserver + /pserver
    @@ -37125,7 +42579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    pserver object that needs to be created or updated

    +

    pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)

    @@ -37195,6 +42649,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing pserver
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -37414,7 +42957,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /lag-interfaces
    @@ -37614,7 +43157,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /lag-interface
    @@ -37661,7 +43204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

    @@ -37747,6 +43290,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing lag-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -38028,7 +43676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -38289,7 +43937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -38336,7 +43984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -38438,6 +44086,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -38857,7 +44626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -38904,7 +44673,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -39023,22 +44792,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -39116,22 +44897,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -39163,35 +44928,176 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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 + + + +
    + 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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -39719,7 +45625,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -39766,7 +45672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -39885,22 +45791,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -39978,22 +45896,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -40025,35 +45927,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -40131,6 +46021,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -40163,22 +46069,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -40287,35 +46205,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -40750,7 +46793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -41087,7 +47130,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -41134,7 +47177,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -41252,6 +47295,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing sriov-vf
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -41412,7 +47592,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -41888,7 +48068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -42195,7 +48375,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -42242,7 +48422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -42360,6 +48540,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vlan
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -42841,7 +49158,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -42888,7 +49205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -43022,6 +49339,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -43198,7 +49668,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -43813,7 +50283,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -43860,7 +50330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -43995,22 +50465,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -44104,22 +50586,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -44151,35 +50617,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -44273,6 +50727,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -44305,22 +50775,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -44445,35 +50927,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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
    +

    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -44551,6 +51021,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -44583,22 +51069,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -44707,35 +51205,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -44781,73 +51267,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - -
    - hostname + interface-name -

    Value from executing hostname on the compute node.

    +

    Name given to the interface

    		 path @@ -44860,10 +51285,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -44905,17 +51330,215 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns p-interfaces

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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

    @@ -45031,7 +51654,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /p-interfaces + /p-interfaces
    @@ -45216,7 +51839,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /p-interface + /p-interface
    @@ -45263,7 +51886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated

    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    @@ -45349,6 +51972,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing p-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -45615,7 +52343,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -45861,7 +52589,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -45908,7 +52636,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -46010,6 +52738,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -46414,7 +53263,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -46461,7 +53310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -46579,6 +53428,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -46739,7 +53725,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -47261,7 +54247,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -47308,7 +54294,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -47427,16 +54413,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be 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

    @@ -47586,7 +54709,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -47848,7 +54971,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -48277,7 +55400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -48599,7 +55722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -48646,7 +55769,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -48764,6 +55887,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing sriov-vf
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -48924,7 +56184,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -49385,7 +56645,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -49677,7 +56937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -49724,7 +56984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -49843,16 +57103,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing vlan
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing 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
    -

    delete an existing vlan

    +

    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

    @@ -50308,7 +57705,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -50355,7 +57752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -50489,6 +57886,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -50665,7 +58215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -51265,7 +58815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -51312,7 +58862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -51447,22 +58997,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -51556,22 +59118,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -51603,35 +59149,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -51725,6 +59259,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -51757,22 +59307,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -51897,35 +59459,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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
    +

    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -52003,6 +59553,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -52035,22 +59601,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -52159,35 +59737,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -52233,73 +59799,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + +
    - hostname + interface-name -

    Value from executing hostname on the compute node.

    +

    Name given to the interface

    		 path @@ -52312,10 +59817,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name that identifies the physical interface

    +

    String that identifies the interface

    		 path @@ -52357,17 +59862,215 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-pfs
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns sriov-pfs

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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

    @@ -52514,7 +60217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-pfs + /sriov-pfs
    @@ -52715,7 +60418,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-pf + /sriov-pf
    @@ -52762,7 +60465,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-pf object that needs to be created or updated

    +

    sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

    @@ -52865,22 +60568,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing sriov-pf
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

    +
    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
    -

    delete an existing sriov-pf

    +

    update an existing sriov-pf

    application/json application/xml

    +
    +
    +

    sriov-pf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-pf +
    +
    +
    @@ -52942,22 +60657,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -52989,35 +60688,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-pf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -53079,6 +60766,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -53111,16 +60814,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/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

    @@ -53238,7 +61062,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)

    @@ -53421,7 +61245,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /virtual-data-centers + /virtual-data-centers
    @@ -53531,7 +61355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /virtual-data-center + /virtual-data-center
    @@ -53578,7 +61402,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    virtual-data-center object that needs to be created or updated

    +

    virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

    @@ -53648,6 +61472,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing virtual-data-center
    +

    PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -53760,7 +61673,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

    @@ -53907,17 +61820,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-ems-list
    -

    GET /external-system/esr-ems-list

    +
    returns configurations
    +

    GET /network/configurations

    Tags: - ExternalSystem + Network
    -

    returns esr-ems-list

    +

    returns configurations

    @@ -53943,7 +61856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-ems-list + /configurations
    @@ -53971,17 +61884,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-ems
    -

    GET /external-system/esr-ems-list/esr-ems/{ems-id}

    +
    returns configuration
    +

    GET /network/configurations/configuration/{configuration-id}

    Tags: - ExternalSystem + Network
    -

    returns esr-ems

    +

    returns configuration

    @@ -53998,10 +61911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54012,6 +61925,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + model-version-id + +

    the ASDC model version for this resource or service model.

    +     		query + string + + +
    @@ -54038,7 +61981,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-ems + /configuration
    @@ -54066,17 +62009,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing esr-ems
    -

    PUT /external-system/esr-ems-list/esr-ems/{ems-id}

    +
    create or update an existing configuration
    +

    PUT /network/configurations/configuration/{configuration-id}

    Tags: - ExternalSystem + Network
    -

    create or update an existing esr-ems

    +

    create or update an existing configuration

    @@ -54085,13 +62028,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-ems object that needs to be created or updated

    +

    configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)

    - /esr-ems + /configuration
    @@ -54110,10 +62053,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54155,23 +62098,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing esr-ems
    -

    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}

    +
    update an existing configuration
    +

    PATCH /network/configurations/configuration/{configuration-id}

    Tags: - ExternalSystem + Network
    -

    delete an existing esr-ems

    +

    update an existing configuration

    application/json application/xml

    +
    +
    +

    configuration object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /configuration +
    +
    +
    @@ -54187,10 +62142,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54201,22 +62156,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -54248,19 +62187,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-system-info-list
    -

    GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list

    +
    delete an existing configuration
    +

    DELETE /network/configurations/configuration/{configuration-id}

    Tags: - ExternalSystem + Network
    -

    returns esr-system-info-list

    +

    delete an existing configuration

    +
    + +

    application/json application/xml +

    +
    @@ -54275,10 +62219,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + +
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54289,6 +62233,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + 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 + + +
    @@ -54315,7 +62377,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info-list + /metadata
    @@ -54343,17 +62405,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-system-info
    -

    GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    returns metadatum
    +

    GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

    Tags: - ExternalSystem + Network
    -

    returns esr-system-info

    +

    returns metadatum

    @@ -54370,10 +62432,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54386,10 +62448,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + metaname -

    Unique ID of esr system info.

    		 path @@ -54402,10 +62463,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - system-name + model-invariant-id -

    name of external system.

    +

    the ASDC model id for this resource or service model.

    		 query @@ -54417,10 +62478,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - system-type + model-version-id -

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    +

    the ASDC model version for this resource or service model.

    		 query @@ -54456,7 +62517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info + /metadatum
    @@ -54484,17 +62545,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing esr-system-info
    -

    PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    create or update an existing metadatum
    +

    PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

    Tags: - ExternalSystem + Network
    -

    create or update an existing esr-system-info

    +

    create or update an existing metadatum

    @@ -54503,13 +62564,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-system-info object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)

    - /esr-system-info + /metadatum
    @@ -54528,10 +62589,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54544,10 +62605,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + metaname -

    Unique ID of esr system info.

    		 path @@ -54589,23 +62649,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing esr-system-info
    -

    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    update an existing metadatum
    +

    PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

    Tags: - ExternalSystem + Network
    -

    delete an existing esr-system-info

    +

    update an existing metadatum

    application/json application/xml

    +
    +
    +

    metadatum object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /metadatum +
    +
    +
    @@ -54621,10 +62693,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - ems-id + configuration-id -

    Unique ID of EMS.

    +

    UUID assigned to configuration.

    		 path @@ -54637,10 +62709,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + 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 -

    Unique ID of esr system info.

    		 path @@ -54698,13 +62861,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    +

    PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

    Tags: - ExternalSystem + Network
    @@ -54717,7 +62880,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)

    @@ -54742,26 +62905,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ems-id - -

    Unique ID of EMS.

    -     		path - string - - - -
    - esr-system-info-id + configuration-id -

    Unique ID of esr system info.

    +

    UUID assigned to configuration.

    		 path @@ -54803,13 +62950,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    +

    DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

    Tags: - ExternalSystem + Network
    @@ -54835,26 +62982,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ems-id + configuration-id -

    Unique ID of EMS.

    -     		path - string - - - -
    - esr-system-info-id - -

    Unique ID of esr system info.

    +

    UUID assigned to configuration.

    		 path @@ -54896,73 +63027,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

    +
    returns generic-vnfs
    +

    GET /network/generic-vnfs

    Tags: - ExternalSystem + Network
    -

    see node definition for valid relationships

    +

    returns generic-vnfs

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - - -
    - ems-id - -

    Unique ID of EMS.

    -     		path - string - - - -
    -

    application/json application/xml

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /generic-vnfs +
    +
    +
    + +
    default @@ -54985,24 +63091,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

    +
    returns generic-vnf
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: - ExternalSystem + Network
    -

    delete an existing relationship

    +

    returns generic-vnf

    -
    - -

    application/json application/xml -

    -
    @@ -55017,10 +63118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - ems-id + vnf-id -

    Unique ID of EMS.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55031,51 +63132,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + service-id + +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +     		query + string + + +
    + regional-resource-zone + +

    Regional way of organizing pservers, source of truth should define values

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + model-version-id + +

    the ASDC model version for this resource or service model.

    +     		query + string + + +
    + widget-model-id + +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +     		query + string + + +
    + widget-model-version + +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + string + + +
    + nf-type + +

    Generic description of the type of NF

    +     		query + string + + +
    + nf-function + +

    English description of Network function that the specific VNF deployment is providing

    +     		query + string + + +
    + nf-role + +

    role in the network that this model will be providing

    +     		query + string + + +
    + nf-naming-code + +

    string assigned to this model used for naming purposes

    +     		query + string + + +
    -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns esr-thirdparty-sdnc-list
    -

    GET /external-system/esr-thirdparty-sdnc-list

    - Tags: - ExternalSystem -
    -
    -
    -

    returns esr-thirdparty-sdnc-list

    - -
    -

    application/json application/xml

    @@ -55098,7 +63411,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-thirdparty-sdnc-list + /generic-vnf
    @@ -55126,19 +63439,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-thirdparty-sdnc
    -

    GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

    +
    create or update an existing generic-vnf
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: - ExternalSystem + Network
    -

    returns esr-thirdparty-sdnc

    +

    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/v11/NetworkGenericVnfsGenericVnf.json)

    +

    +
    +
    +
    +
    + /generic-vnf +
    +
    +
    +
    @@ -55153,10 +63483,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55176,29 +63506,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /esr-thirdparty-sdnc -
    -
    -
    - -
    default @@ -55221,17 +63528,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing esr-thirdparty-sdnc
    -

    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

    +
    update an existing generic-vnf
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: - ExternalSystem + Network
    -

    create or update an existing esr-thirdparty-sdnc

    +

    update an existing generic-vnf

    @@ -55240,13 +63547,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-thirdparty-sdnc object that needs to be created or updated

    +

    generic-vnf object that needs to be created or updated.

    - /esr-thirdparty-sdnc + /generic-vnf
    @@ -55265,10 +63572,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55310,17 +63617,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing esr-thirdparty-sdnc
    -

    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

    +
    delete an existing generic-vnf
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: - ExternalSystem + Network
    -

    delete an existing esr-thirdparty-sdnc

    +

    delete an existing generic-vnf

    @@ -55342,10 +63649,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55403,17 +63710,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns esr-system-info-list
    -

    GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list

    +
    returns entitlements
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

    Tags: - ExternalSystem + Network
    -

    returns esr-system-info-list

    +

    returns entitlements

    @@ -55430,10 +63737,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55444,6 +63751,259 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + service-id + +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +     		query + string + + +
    + regional-resource-zone + +

    Regional way of organizing pservers, source of truth should define values

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + model-version-id + +

    the ASDC model version for this resource or service model.

    +     		query + string + + +
    + widget-model-id + +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +     		query + string + + +
    + widget-model-version + +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + string + + +
    + nf-type + +

    Generic description of the type of NF

    +     		query + string + + +
    + nf-function + +

    English description of Network function that the specific VNF deployment is providing

    +     		query + string + + +
    + nf-role + +

    role in the network that this model will be providing

    +     		query + string + + +
    + nf-naming-code + +

    string assigned to this model used for naming purposes

    +     		query + string + + +
    @@ -55470,7 +64030,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info-list + /entitlements
    @@ -55498,17 +64058,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-system-info
    -

    GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    returns entitlement
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: - ExternalSystem + Network
    -

    returns esr-system-info

    +

    returns entitlement

    @@ -55525,10 +64085,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55541,10 +64101,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + group-uuid -

    Unique ID of esr system info.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -55557,10 +64117,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - system-name + resource-uuid -

    name of external system.

    +

    Unique ID of an entitlement resource.

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -55572,10 +64148,233 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - system-type + vnf-name2 -

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    +

    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 @@ -55611,7 +64410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info + /entitlement
    @@ -55639,17 +64438,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing esr-system-info
    -

    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    create or update an existing entitlement
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: - ExternalSystem + Network
    -

    create or update an existing esr-system-info

    +

    create or update an existing entitlement

    @@ -55658,13 +64457,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-system-info object that needs to be created or updated

    +

    entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

    - /esr-system-info + /entitlement
    @@ -55683,10 +64482,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55699,10 +64498,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + group-uuid -

    Unique ID of esr system info.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +     		path + string + + + +
    + resource-uuid + +

    Unique ID of an entitlement resource.

    		 path @@ -55744,23 +64559,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing esr-system-info
    -

    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    update an existing entitlement
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: - ExternalSystem + Network
    -

    delete an existing esr-system-info

    +

    update an existing entitlement

    application/json application/xml

    +
    +
    +

    entitlement object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /entitlement +
    +
    +
    @@ -55776,10 +64603,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55792,10 +64619,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + group-uuid -

    Unique ID of esr system info.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -55808,12 +64635,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + resource-uuid -

    resource-version for concurrency

    +

    Unique ID of an entitlement resource.

    		querypath string @@ -55853,35 +64680,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    +
    delete an existing entitlement
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: - ExternalSystem + Network
    -

    see node definition for valid relationships

    +

    delete an existing entitlement

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -55897,10 +64712,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -55913,10 +64728,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + group-uuid -

    Unique ID of esr system info.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -55927,73 +64742,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    - Tags: - ExternalSystem -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - thirdparty-sdnc-id + resource-uuid -

    Unique ID of SDNC.

    +

    Unique ID of an entitlement resource.

    		 path @@ -56006,12 +64760,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + resource-version -

    Unique ID of esr system info.

    +

    resource-version for concurrency

    		pathquery string @@ -56051,13 +64805,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: - ExternalSystem + Network
    @@ -56070,7 +64824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

    @@ -56095,10 +64849,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - thirdparty-sdnc-id + vnf-id -

    Unique ID of SDNC.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -56109,73 +64863,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

    - Tags: - ExternalSystem -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - -
    - thirdparty-sdnc-id + group-uuid -

    Unique ID of SDNC.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56186,132 +64879,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns esr-vnfm-list
    -

    GET /external-system/esr-vnfm-list

    - Tags: - ExternalSystem -
    -
    -
    -

    returns esr-vnfm-list

    - -
    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /esr-vnfm-list -
    -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns esr-vnfm
    -

    GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

    - Tags: - ExternalSystem -
    -
    -
    -

    returns esr-vnfm

    - -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnfm-id + resource-uuid -

    Unique ID of VNFM.

    +

    Unique ID of an entitlement resource.

    		 path @@ -56331,29 +64904,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /esr-vnfm -
    -
    -
    - -
    default @@ -56376,35 +64926,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing esr-vnfm
    -

    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

    +
    delete an existing relationship
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: - ExternalSystem + Network
    -

    create or update an existing esr-vnfm

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    esr-vnfm object that needs to be created or updated

    -

    -
    -
    -
    -
    - /esr-vnfm -
    -
    -
    @@ -56420,10 +64958,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -56434,73 +64972,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing esr-vnfm
    -

    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

    - Tags: - ExternalSystem -
    -
    -
    -

    delete an existing esr-vnfm

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnfm-id + group-uuid -

    Unique ID of VNFM.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56513,12 +64990,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + resource-uuid -

    resource-version for concurrency

    +

    Unique ID of an entitlement resource.

    		querypath string @@ -56558,17 +65035,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns esr-system-info-list
    -

    GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list

    +
    returns l-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

    Tags: - ExternalSystem + Network
    -

    returns esr-system-info-list

    +

    returns l-interfaces

    @@ -56585,10 +65062,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -56599,6 +65076,259 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + service-id + +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +     		query + string + + +
    + regional-resource-zone + +

    Regional way of organizing pservers, source of truth should define values

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + model-version-id + +

    the ASDC model version for this resource or service model.

    +     		query + string + + +
    + widget-model-id + +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +     		query + string + + +
    + widget-model-version + +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + string + + +
    + nf-type + +

    Generic description of the type of NF

    +     		query + string + + +
    + nf-function + +

    English description of Network function that the specific VNF deployment is providing

    +     		query + string + + +
    + nf-role + +

    role in the network that this model will be providing

    +     		query + string + + +
    + nf-naming-code + +

    string assigned to this model used for naming purposes

    +     		query + string + + +
    @@ -56625,7 +65355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info-list + /l-interfaces
    @@ -56653,17 +65383,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns esr-system-info
    -

    GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    returns l-interface
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: - ExternalSystem + Network
    -

    returns esr-system-info

    +

    returns l-interface

    @@ -56680,10 +65410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -56696,10 +65426,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + interface-name -

    Unique ID of esr system info.

    +

    Name given to the interface

    		 path @@ -56712,10 +65442,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - system-name + vnf-name -

    name of external system.

    +

    Name of VNF.

    		 query @@ -56727,10 +65457,278 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - system-type + vnf-name2 -

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    +

    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 @@ -56766,7 +65764,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /esr-system-info + /l-interface
    @@ -56794,17 +65792,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing esr-system-info
    -

    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    create or update an existing l-interface
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: - ExternalSystem + Network
    -

    create or update an existing esr-system-info

    +

    create or update an existing l-interface

    @@ -56813,13 +65811,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    esr-system-info object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

    - /esr-system-info + /l-interface
    @@ -56838,10 +65836,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -56854,10 +65852,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + interface-name -

    Unique ID of esr system info.

    +

    Name given to the interface

    		 path @@ -56899,23 +65897,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing esr-system-info
    -

    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

    +
    update an existing l-interface
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: - ExternalSystem + Network
    -

    delete an existing esr-system-info

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -56931,10 +65941,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -56947,10 +65957,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + interface-name -

    Unique ID of esr system info.

    +

    Name given to the interface

    		 path @@ -56961,22 +65971,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -57008,35 +66002,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    +
    delete an existing l-interface
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: - ExternalSystem + Network
    -

    see node definition for valid relationships

    +

    delete an existing l-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -57052,10 +66034,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -57068,10 +66050,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info-id + interface-name -

    Unique ID of esr system info.

    +

    Name given to the interface

    		 path @@ -57082,6 +66064,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -57113,129 +66111,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    -
    -
    delete an existing relationship
    -

    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

    - Tags: - ExternalSystem -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnfm-id - -

    Unique ID of VNFM.

    -     		path - string - - - -
    - esr-system-info-id - -

    Unique ID of esr system info.

    -     		path - string - - - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

    +
    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: - ExternalSystem + Network
    -

    see node definition for valid relationships

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -57250,10 +66138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnfm-id + vnf-id -

    Unique ID of VNFM.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -57264,73 +66152,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

    - Tags: - ExternalSystem -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - -
    - vnfm-id + interface-name -

    Unique ID of VNFM.

    +

    Name given to the interface

    		 path @@ -57341,132 +66168,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + l3-interface-ipv4-address -

    Unique id of VNF. This is unique across the graph.

    +

    IP address

    		 path @@ -57730,6 +66437,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -57756,7 +66553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /generic-vnf + /l3-interface-ipv4-address-list
    @@ -57784,17 +66581,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing generic-vnf
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    create or update an existing 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 generic-vnf

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -57803,13 +66600,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    generic-vnf object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /generic-vnf + /l3-interface-ipv4-address-list
    @@ -57842,6 +66639,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -57873,23 +66702,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing generic-vnf
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    update an existing 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
    -

    delete an existing generic-vnf

    +

    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 +
    +
    +
    @@ -57921,12 +66762,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + +
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string @@ -57966,19 +66823,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlements
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

    +
    delete an existing 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
    -

    returns entitlements

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -58009,158 +66871,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - + + +
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id + interface-name -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Name given to the interface

    		querypath string +
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id + l3-interface-ipv4-address -

    the ASDC model id for this resource or service model.

    +

    IP address

    		querypath string +
    - model-version-id + resource-version -

    the ASDC model version for this resource or service model.

    +

    resource-version for concurrency

    		 query @@ -58168,96 +66914,237 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/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/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + + +
    - widget-model-id + vnf-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - widget-model-version + interface-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name given to the interface

    		querypath string +
    - nf-type + l3-interface-ipv4-address -

    Generic description of the type of NF

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + - + - + @@ -58269,29 +67156,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /entitlements -
    -
    -
    - -
    default @@ -58314,17 +67178,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlement
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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 entitlement

    +

    returns l3-interface-ipv6-address-list

    @@ -58357,10 +67221,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - nf-function + vnf-id -

    English description of Network function that the specific VNF deployment is providing

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - nf-role + interface-name -

    role in the network that this model will be providing

    +

    Name given to the interface

    		querypath string +
    - nf-naming-code + l3-interface-ipv4-address -

    string assigned to this model used for naming purposes

    +

    IP address

    		querypath string +
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name given to the interface

    		 path @@ -58373,10 +67237,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv6-address -

    Unique ID of an entitlement resource.

    +

    IP address

    		 path @@ -58640,6 +67504,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -58666,7 +67620,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /entitlement + /l3-interface-ipv6-address-list
    @@ -58694,17 +67648,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing entitlement
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    create or update an existing l3-interface-ipv6-address-list
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    create or update an existing entitlement

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -58713,13 +67667,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    entitlement object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /entitlement + /l3-interface-ipv6-address-list
    @@ -58754,10 +67708,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name given to the interface

    		 path @@ -58770,10 +67724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv6-address -

    Unique ID of an entitlement resource.

    +

    IP address

    		 path @@ -58815,23 +67769,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing entitlement
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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
    -

    delete an existing entitlement

    +

    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 +
    +
    +
    @@ -58863,10 +67829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name given to the interface

    		 path @@ -58879,10 +67845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv6-address -

    Unique ID of an entitlement resource.

    +

    IP address

    		 path @@ -58893,22 +67859,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -58940,35 +67890,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -59000,10 +67938,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name given to the interface

    		 path @@ -59016,10 +67954,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv6-address -

    Unique ID of an entitlement resource.

    +

    IP address

    		 path @@ -59030,18 +67968,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default +
    @@ -59061,23 +68015,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -59109,10 +68075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name given to the interface

    		 path @@ -59125,10 +68091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv6-address -

    Unique ID of an entitlement resource.

    +

    IP address

    		 path @@ -59170,19 +68136,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

    +
    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
    -

    returns l-interfaces

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -59213,255 +68184,232 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + +
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id + interface-name -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Name given to the interface

    		querypath string +
    - widget-model-version + l3-interface-ipv6-address -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + +
    - nf-type + vnf-id -

    Generic description of the type of NF

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - nf-function + interface-name -

    English description of Network function that the specific VNF deployment is providing

    +

    Name given to the interface

    		querypath string +
    +
    + +
    +

    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 +

    +
    +
    + + + + + + + + + + + - + - + @@ -59473,29 +68421,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -59518,17 +68443,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    +
    returns sriov-vfs
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: Network
    -

    returns l-interface

    +

    returns sriov-vfs

    @@ -59899,7 +68824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /sriov-vfs
    @@ -59927,231 +68852,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    create or update an existing l-interface

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    l-interface object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l-interface -
    -
    -
    -
    -
    -
    - nf-role + vnf-id -

    role in the network that this model will be providing

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - nf-naming-code + interface-name -

    string assigned to this model used for naming purposes

    +

    Name given to the interface

    		querypath string +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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

    +

    returns sriov-vf

    @@ -60200,10 +68911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60514,14 +69225,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + vf-vlan-filter -

    Inner VLAN tag

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query - integer + string @@ -60529,10 +69240,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + vf-mac-filter -

    Neutron network id of the interface that address belongs to

    +

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    		 query @@ -60544,10 +69255,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + vf-vlan-strip -

    Neutron id of subnet that address belongs to

    +

    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 @@ -60583,7 +69309,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /sriov-vf
    @@ -60611,17 +69337,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/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 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 l3-interface-ipv4-address-list

    +

    create or update an existing sriov-vf

    @@ -60630,13 +69356,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

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l3-interface-ipv4-address-list + /sriov-vf
    @@ -60687,10 +69413,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60732,23 +69458,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -60796,10 +69534,119 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    +     		path + 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 @@ -60857,11 +69704,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    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
    @@ -60876,7 +69723,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -60933,10 +69780,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60978,11 +69825,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
    @@ -61042,10 +69889,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -61087,17 +69934,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns vlans
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns vlans

    @@ -61144,22 +69991,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    vnf-name @@ -61458,51 +70289,6 @@ 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 - -

    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 - - -
    @@ -61529,7 +70315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /vlans
    @@ -61557,36 +70343,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns vlan
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -61633,10 +70402,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 @@ -61647,121 +70416,325 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /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 -

    -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -61781,6 +70753,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    default @@ -61803,17 +70798,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing vlan

    @@ -61822,13 +70817,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

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

    - /relationship + /vlan
    @@ -61879,10 +70874,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + vnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name of VNF.

    		pathquery string -
    - interface-name + vnf-name2 -

    Name given to the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-type -

    IP address

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - resource-version + service-id -

    resource-version for concurrency

    +

    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 @@ -61769,7 +70742,6 @@ 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 @@ -61924,23 +70919,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing vlan
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -61988,10 +70995,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 @@ -62033,35 +71040,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing vlan
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -62107,6 +71102,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -62138,24 +71165,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -62200,68 +71222,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + vlan-interface -

    Unique id of VNF. This is unique across the graph.

    +

    String that identifies the interface

    		 path @@ -62274,10 +71240,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -62586,411 +71552,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 + vlan-id-inner -

    MAC address for the interface

    +

    Inner VLAN tag

    		 query - string + integer @@ -62998,10 +71569,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-key -

    Name of the network

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -63013,14 +71584,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-filter + vlan-id-inner -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Inner VLAN tag

    		 query - string + integer @@ -63028,10 +71599,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + neutron-network-id -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -63043,25 +71614,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 + neutron-subnet-id -

    Neutron network id of the interface

    +

    Neutron id of subnet that address belongs to

    		 query @@ -63097,7 +71653,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /l3-interface-ipv4-address-list
    @@ -63125,17 +71681,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/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -63144,13 +71700,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /sriov-vf + /l3-interface-ipv4-address-list
    @@ -63201,10 +71757,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -63246,23 +71818,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    delete an existing sriov-vf

    +

    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 +
    +
    +
    @@ -63310,10 +71894,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -63326,12 +71910,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -63371,35 +71955,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -63447,10 +72019,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -63461,6 +72049,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -63492,23 +72096,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -63556,10 +72172,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -63601,19 +72233,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -63660,300 +72297,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -63965,29 +72336,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -64010,17 +72358,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    returns l3-interface-ipv6-address-list

    @@ -64083,6 +72431,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -     		query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -     		query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -     		query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -     		query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath string +
    - network-name + l3-interface-ipv4-address -

    Name of the network

    +

    IP address

    		querypath string +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    vnf-name @@ -64411,6 +72775,51 @@ 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 + +

    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 + + +
    @@ -64437,7 +72846,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /l3-interface-ipv6-address-list
    @@ -64465,17 +72874,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -64484,13 +72893,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /vlan + /l3-interface-ipv6-address-list
    @@ -64555,6 +72964,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -64586,23 +73011,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    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 +
    +
    +
    @@ -64666,12 +73103,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -64711,19 +73148,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -64786,7 +73228,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -65182,29 +73267,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -65227,17 +73289,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/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}

    +
    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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -65246,13 +73308,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /relationship
    @@ -65319,7 +73381,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -64802,368 +73244,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -     		query - string - - -
    - nf-type - -

    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 + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -65171,6 +73255,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -65364,17 +73426,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/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 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 l3-interface-ipv4-address-list

    +

    delete an existing relationship

    @@ -65444,7 +73506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -65458,22 +73520,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -65505,11 +73551,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: Network
    @@ -65524,7 +73570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

    @@ -65595,22 +73641,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -65642,11 +73672,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: Network
    @@ -65720,22 +73750,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -65767,17 +73781,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns lag-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns lag-interfaces

    @@ -65810,58 +73824,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name given to the interface

    +

    Name of VNF.

    		pathquery string -
    - vlan-interface + vnf-name2 -

    String that identifies the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-type -

    IP address

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - vnf-name + service-id -

    Name of VNF.

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -65873,10 +73884,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name2 + regional-resource-zone -

    Alternate name of VNF.

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -65888,10 +73899,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + prov-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -65903,10 +73914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + heat-stack-id -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -65918,10 +73929,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + in-maint -

    Regional way of organizing pservers, source of truth should define values

    +     		query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    		 query @@ -65933,10 +73972,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + model-version-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    the ASDC model version for this resource or service model.

    		 query @@ -65948,10 +73987,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + widget-model-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -65963,13 +74002,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + widget-model-version +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query - boolean + string @@ -65977,13 +74017,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + nf-type +

    Generic description of the type of NF

    		 query - boolean + string @@ -65991,10 +74032,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + nf-function -

    the ASDC model id for this resource or service model.

    +

    English description of Network function that the specific VNF deployment is providing

    		 query @@ -66006,10 +74047,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + nf-role -

    the ASDC model version for this resource or service model.

    +

    role in the network that this model will be providing

    		 query @@ -66021,10 +74062,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + nf-naming-code -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    string assigned to this model used for naming purposes

    		 query @@ -66034,12 +74075,123 @@ 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/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 + + + +
    - widget-model-version + interface-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -66051,10 +74203,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-type + vnf-name2 -

    Generic description of the type of NF

    +

    Alternate name of VNF.

    		 query @@ -66066,10 +74218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-function + vnf-type -

    English description of Network function that the specific VNF deployment is providing

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -66081,10 +74233,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-role + service-id -

    role in the network that this model will be providing

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -66096,10 +74248,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-naming-code + regional-resource-zone -

    string assigned to this model used for naming purposes

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -66111,10 +74263,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + prov-status -

    ID of interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -66126,10 +74278,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + heat-stack-id -

    MAC address for the interface

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -66141,10 +74293,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + in-maint -

    Name of the network

    +     		query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    		 query @@ -66156,14 +74336,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + model-version-id -

    Inner VLAN tag

    +

    the ASDC model version for this resource or service model.

    		 query - integer + string @@ -66171,10 +74351,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-key + widget-model-id -

    This indicates the customers VPN ID associated with this vlan

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -66186,14 +74366,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + widget-model-version -

    Inner VLAN tag

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query - integer + string @@ -66201,10 +74381,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + nf-type -

    Neutron network id of the interface that address belongs to

    +

    Generic description of the type of NF

    		 query @@ -66216,10 +74396,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + nf-function -

    Neutron id of subnet that address belongs to

    +

    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 @@ -66255,7 +74495,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /lag-interface
    @@ -66283,17 +74523,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    create or update an existing lag-interface

    @@ -66302,13 +74542,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

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

    - /l3-interface-ipv6-address-list + /lag-interface
    @@ -66346,39 +74586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    +

    Name that identifies the link aggregate interface

    		 path @@ -66420,23 +74628,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 lag-interface
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing lag-interface

    application/json application/xml

    +
    +
    +

    lag-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    @@ -66471,7 +74691,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 @@ -66482,12 +74702,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vlan-interface + vnf-id -

    String that identifies the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -66500,10 +74781,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 that identifies the link aggregate interface

    		 path @@ -66561,36 +74842,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -66624,7 +74888,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 @@ -66637,471 +74901,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vnf-name -

    String that identifies the interface

    +

    Name of VNF.

    		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

    -

    -
    -
    -
    -
    - /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.

    -     		queryquery string @@ -67347,6 +75152,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -67373,7 +75208,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /l-interfaces
    @@ -67401,17 +75236,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns lag-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    +
    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 lag-interface

    +

    returns l-interface

    @@ -67458,6 +75293,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    vnf-name @@ -67741,6 +75592,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    @@ -67767,7 +75663,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /l-interface
    @@ -67795,17 +75691,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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    +
    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 lag-interface

    +

    create or update an existing l-interface

    @@ -67814,13 +75710,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

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    - /lag-interface + /l-interface
    @@ -67869,6 +75765,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    @@ -67900,23 +75812,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing lag-interface
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    +
    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
    -

    delete an existing lag-interface

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -67964,12 +75888,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -68009,19 +75933,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +
    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
    -

    returns l-interfaces

    +

    delete an existing l-interface

    +
    + +

    application/json application/xml +

    +
    @@ -68068,278 +75997,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -68358,29 +76036,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -68403,17 +76058,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    returns l3-interface-ipv4-address-list

    @@ -68476,6 +76131,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -     		query - string - - -
    - nf-type - -

    Generic description of the type of NF

    -     		query - string - - -
    - nf-function - -

    English description of Network function that the specific VNF deployment is providing

    -     		query - string - - -
    - nf-role - -

    role in the network that this model will be providing

    -     		query - string - - -
    - nf-naming-code - -

    string assigned to this model used for naming purposes

    -     		query - string - - -
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - interface-role + resource-version -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    resource-version for concurrency

    		 query @@ -68347,6 +76024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    vnf-name @@ -68804,6 +76475,51 @@ 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 + +

    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 + + +
    @@ -68830,7 +76546,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l3-interface-ipv4-address-list
    @@ -68858,17 +76574,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -68877,13 +76593,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /l-interface + /l3-interface-ipv4-address-list
    @@ -68948,6 +76664,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -68979,32 +76711,169 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    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 +

    +
    +
    + + + + + + + @@ -69057,6 +76926,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    resource-version @@ -69104,19 +76989,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /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
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -69193,6 +77095,251 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 @@ -69592,7 +77739,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -69620,17 +77767,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/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-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-ipv4-address-list

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -69639,13 +77786,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -69712,7 +77859,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -69757,23 +77904,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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-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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -69837,7 +77996,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -69851,22 +78010,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -69898,35 +78041,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -69990,7 +78121,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -70004,6 +78135,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -70035,23 +78182,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -70115,7 +78274,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -70160,19 +78319,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    delete an existing relationship
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -70249,6 +78413,340 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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/v11/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 @@ -70577,51 +79075,6 @@ 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 - -

    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 - - -
    @@ -70648,7 +79101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /sriov-vfs
    @@ -70676,36 +79129,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -70768,10 +79204,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -70782,6 +79218,394 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + service-id + +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +     		query + string + + +
    + regional-resource-zone + +

    Regional way of organizing pservers, source of truth should define values

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + model-invariant-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + model-version-id + +

    the ASDC model version for this resource or service model.

    +     		query + string + + +
    + widget-model-id + +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +     		query + string + + +
    + widget-model-version + +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + string + + +
    + nf-type + +

    Generic description of the type of NF

    +     		query + string + + +
    + nf-function + +

    English description of Network function that the specific VNF deployment is providing

    +     		query + string + + +
    + nf-role + +

    role in the network that this model will be providing

    +     		query + string + + +
    + nf-naming-code + +

    string assigned to this model used for naming purposes

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + 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 + + +
    @@ -70791,6 +79615,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -70813,23 +79660,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 sriov-vf
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -70893,10 +79752,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -70907,22 +79766,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -70954,17 +79797,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing sriov-vf
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing sriov-vf

    @@ -70973,13 +79816,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

    +

    sriov-vf object that needs to be created or updated.

    - /relationship + /sriov-vf
    @@ -71046,10 +79889,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -71091,17 +79934,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing sriov-vf
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing sriov-vf

    @@ -71171,10 +80014,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -71185,6 +80028,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -71216,11 +80075,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -71235,7 +80094,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -71306,6 +80165,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    @@ -71337,11 +80212,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -71415,6 +80290,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    @@ -71446,17 +80337,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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 sriov-vfs

    +

    returns vlans

    @@ -71873,7 +80764,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /vlans
    @@ -71901,17 +80792,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 sriov-vf

    +

    returns vlan

    @@ -71976,10 +80867,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -72320,44 +81211,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vlan-id-inner -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    +

    Inner VLAN tag

    		 query - boolean + integer @@ -72365,10 +81226,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + vpn-key -

    Neutron network id of the interface

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -72404,7 +81265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /vlan
    @@ -72432,17 +81293,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/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 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 sriov-vf

    +

    create or update an existing vlan

    @@ -72451,13 +81312,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /sriov-vf + /vlan
    @@ -72524,10 +81385,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -72569,23 +81430,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    delete an existing sriov-vf

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -72649,10 +81522,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -72663,22 +81536,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -72710,35 +81567,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -72802,10 +81647,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -72816,6 +81661,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -72847,24 +81708,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -72927,98 +81783,10 @@ 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/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 + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -73031,10 +81799,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -73373,6 +82141,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -73399,7 +82242,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /l3-interface-ipv4-address-list
    @@ -73427,19 +82270,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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
    -

    returns vlan

    +

    create or update an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    @@ -73518,353 +82378,320 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id + l3-interface-ipv4-address -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing l3-interface-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 +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + - + + +
    - widget-model-version + vnf-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - nf-type + interface-name -

    Generic description of the type of NF

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - nf-function + interface-name -

    English description of Network function that the specific VNF deployment is providing

    +

    Name given to the interface

    		querypath string +
    - nf-role + vlan-interface -

    role in the network that this model will be providing

    +

    String that identifies the interface

    		querypath string +
    - nf-naming-code + l3-interface-ipv4-address -

    string assigned to this model used for naming purposes

    +

    IP address

    		querypath string +
    +
    + +
    +

    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 +

    +
    +
    + + + + + + + + + + + - + - + - + - + - + - - - - - - - @@ -73883,29 +82711,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -73928,17 +82733,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    create or update an existing vlan

    +

    see node definition for valid relationships

    @@ -73947,13 +82752,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /vlan + /relationship
    @@ -74034,6 +82839,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + +
    - interface-id + vnf-id -

    ID of interface

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - interface-role + interface-name -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - macaddr + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath string +
    - network-name + l3-interface-ipv4-address -

    Name of the network

    +

    IP address

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-key + resource-version -

    This indicates the customers VPN ID associated with this vlan

    +

    resource-version for concurrency

    		 query @@ -73872,6 +82699,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -74065,17 +82886,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 vlan

    +

    delete an existing relationship

    @@ -74161,12 +82982,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -74206,17 +83027,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-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-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-ipv4-address-list

    +

    returns l3-interface-ipv6-address-list

    @@ -74297,7 +83118,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -74740,7 +83561,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -74768,17 +83589,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/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-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-ipv4-address-list

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -74787,13 +83608,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -74876,7 +83697,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -74921,23 +83742,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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-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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -75017,7 +83850,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - l3-interface-ipv4-address + l3-interface-ipv6-address + +

    IP address

    +     		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

    @@ -75078,11 +84052,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -75097,7 +84071,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -75186,7 +84160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -75231,11 +84205,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -75327,7 +84301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -75372,19 +84346,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -75461,12 +84452,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/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 +

    +
    +
    + + + + + + + + + + + - + - + - + + +
    - l3-interface-ipv6-address + vnf-id -

    IP address

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -75479,158 +84531,328 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + interface-name -

    Name of VNF.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name given to the interface

    		querypath string +
    - vnf-type + vlan-interface -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    String that identifies the interface

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/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/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + +
    - service-id + vnf-id -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - regional-resource-zone + interface-name -

    Regional way of organizing pservers, source of truth should define values

    +

    Name 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/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 +

    +
    +
    + + + + + + + + + + + - + - + + +
    - prov-status + vnf-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - heat-stack-id + interface-name -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Name that identifies the link aggregate interface

    		querypath string +
    +
    + +
    +

    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

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - + - - - - - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id + vnf-id -

    the ASDC model id for this resource or service model.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - model-version-id + vnf-name -

    the ASDC model version for this resource or service model.

    +

    Name of VNF.

    		 query @@ -75642,10 +84864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vnf-name2 -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Alternate name of VNF.

    		 query @@ -75657,10 +84879,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vnf-type -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -75672,10 +84894,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-type + service-id -

    Generic description of the type of NF

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -75687,10 +84909,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-function + regional-resource-zone -

    English description of Network function that the specific VNF deployment is providing

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -75702,10 +84924,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-role + prov-status -

    role in the network that this model will be providing

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -75717,10 +84939,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-naming-code + heat-stack-id -

    string assigned to this model used for naming purposes

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -75732,14 +84954,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + in-maint -

    ID of interface

    		 query - string + boolean @@ -75747,14 +84968,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + is-closed-loop-disabled -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query - string + boolean @@ -75762,10 +84982,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + model-invariant-id -

    ID of interface

    +

    the ASDC model id for this resource or service model.

    		 query @@ -75777,10 +84997,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + model-version-id -

    MAC address for the interface

    +

    the ASDC model version for this resource or service model.

    		 query @@ -75792,10 +85012,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + widget-model-id -

    Name of the network

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -75807,14 +85027,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + widget-model-version -

    Inner VLAN tag

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query - integer + string @@ -75822,10 +85042,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-key + nf-type -

    This indicates the customers VPN ID associated with this vlan

    +

    Generic description of the type of NF

    		 query @@ -75837,14 +85057,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + nf-function -

    Inner VLAN tag

    +

    English description of Network function that the specific VNF deployment is providing

    		 query - integer + string @@ -75852,10 +85072,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + nf-role -

    Neutron network id of the interface that address belongs to

    +

    role in the network that this model will be providing

    		 query @@ -75867,10 +85087,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + nf-naming-code -

    Neutron id of subnet that address belongs to

    +

    string assigned to this model used for naming purposes

    		 query @@ -75906,7 +85126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /licenses
    @@ -75934,36 +85154,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns license
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns license

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -75994,10 +85197,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
    - interface-name + group-uuid -

    Name that identifies the link aggregate interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76010,10 +85213,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-uuid -

    Name given to the interface

    +

    Unique ID of a license resource.

    		 path @@ -76026,183 +85229,248 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vnf-name -

    String that identifies the interface

    +

    Name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-name2 -

    IP address

    +

    Alternate name of VNF.

    		pathquery 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -76222,6 +85489,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /license +
    +
    +
    + +
    default @@ -76244,17 +85534,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    create or update an existing license
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing license

    @@ -76263,13 +85553,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

    +

    license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)

    - /relationship + /license
    @@ -76304,42 +85594,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id + vnf-type -

    Unique id of VNF. This is unique across the graph.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - interface-name + service-id -

    Name that identifies the link aggregate interface

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		pathquery string -
    - interface-name + regional-resource-zone -

    Name given to the interface

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv6-address + heat-stack-id -

    IP address

    +

    Heat stack id corresponding to this instance, managed by MSO

    		pathquery string -
    - resource-version + in-maint -

    resource-version for concurrency

    +     		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 @@ -76210,7 +85478,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + group-uuid -

    String that identifies the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76352,10 +85610,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-uuid -

    IP address

    +

    Unique ID of a license resource.

    		 path @@ -76397,23 +85655,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing license
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing license

    application/json application/xml

    +
    +
    +

    license object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /license +
    +
    +
    @@ -76445,26 +85715,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + +
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76477,10 +85731,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of a license resource.

    		 path @@ -76491,12 +85745,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - l3-interface-ipv6-address + vnf-id -

    IP address

    +

    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 @@ -76507,6 +85854,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -76538,11 +85901,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -76557,7 +85920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)

    @@ -76598,26 +85961,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76630,10 +85977,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of a license resource.

    		 path @@ -76675,11 +86022,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -76723,26 +86070,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76755,10 +86086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of a license resource.

    		 path @@ -76800,11 +86131,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    Tags: Network
    @@ -76819,7 +86150,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)

    @@ -76858,22 +86189,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    @@ -76905,11 +86220,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    Tags: Network
    @@ -76951,22 +86266,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    @@ -76998,17 +86297,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns licenses
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

    +
    returns vf-modules
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

    Tags: Network
    -

    returns licenses

    +

    returns vf-modules

    @@ -77318,7 +86617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /licenses + /vf-modules
    @@ -77346,17 +86645,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns license
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    returns vf-module
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    returns license

    +

    returns vf-module

    @@ -77389,26 +86688,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid - -

    Unique ID for the license group the resource belongs to, should be uuid.

    -     		path - string - - - -
    - resource-uuid + vf-module-id -

    Unique ID of a license resource.

    +

    Unique ID of vf-module.

    		 path @@ -77672,6 +86955,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -77698,7 +87086,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /license + /vf-module
    @@ -77726,17 +87114,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing license
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    create or update an existing vf-module
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    create or update an existing license

    +

    create or update an existing vf-module

    @@ -77745,13 +87133,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    license object that needs to be created or updated

    +

    vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    - /license + /vf-module
    @@ -77786,26 +87174,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid - -

    Unique ID for the license group the resource belongs to, should be uuid.

    -     		path - string - - - -
    - resource-uuid + vf-module-id -

    Unique ID of a license resource.

    +

    Unique ID of vf-module.

    		 path @@ -77847,23 +87219,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing license
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    update an existing vf-module
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    delete an existing license

    +

    update an existing vf-module

    application/json application/xml

    +
    +
    +

    vf-module object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vf-module +
    +
    +
    @@ -77895,26 +87279,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - group-uuid - -

    Unique ID for the license group the resource belongs to, should be uuid.

    -     		path - string - - - -
    - resource-uuid + vf-module-id -

    Unique ID of a license resource.

    +

    Unique ID of vf-module.

    		 path @@ -77925,22 +87293,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -77972,35 +87324,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    delete an existing vf-module
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vf-module

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -78032,10 +87372,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - group-uuid + vf-module-id -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Unique ID of vf-module.

    		 path @@ -78048,12 +87388,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + resource-version -

    Unique ID of a license resource.

    +

    resource-version for concurrency

    		pathquery string @@ -78093,23 +87433,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -78141,26 +87493,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - group-uuid - -

    Unique ID for the license group the resource belongs to, should be uuid.

    -     		path - string - - - -
    - resource-uuid + vf-module-id -

    Unique ID of a license resource.

    +

    Unique ID of vf-module.

    		 path @@ -78202,35 +87538,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /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

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -78260,6 +87584,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + vf-module-id + +

    Unique ID of vf-module.

    +     		path + string + + + +
    @@ -78291,61 +87631,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    +
    returns instance-groups
    +

    GET /network/instance-groups

    Tags: Network
    -

    delete an existing relationship

    +

    returns instance-groups

    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - - - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    -

    application/json application/xml

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /instance-groups +
    +
    +
    + +
    default @@ -78368,17 +87695,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vf-modules
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

    +
    returns instance-group
    +

    GET /network/instance-groups/instance-group/{id}

    Tags: Network
    -

    returns vf-modules

    +

    returns instance-group

    @@ -78395,10 +87722,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + id -

    Unique id of VNF. This is unique across the graph.

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -78411,100 +87738,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id + description -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Descriptive text to help identify the usage of this instance-group

    		 query @@ -78516,38 +87753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - model-invariant-id + type -

    the ASDC model id for this resource or service model.

    +

    Only valid value today is lower case ha for high availability

    		 query @@ -78559,10 +87768,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + sub-type -

    the ASDC model version for this resource or service model.

    +

    Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

    		 query @@ -78572,57 +87781,290 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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/v11/NetworkInstanceGroupsInstanceGroup.json)

    +

    +
    +
    +
    +
    + /instance-group +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - widget-model-id + id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Instance Group ID, UUID assigned to this instance.

    		querypath 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 +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - widget-model-version + id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Instance Group ID, UUID assigned to this instance.

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - + + +
    - nf-type + id -

    Generic description of the type of NF

    +

    Instance Group ID, UUID assigned to this instance.

    		querypath string +
    - nf-function + resource-version -

    English description of Network function that the specific VNF deployment is providing

    +

    resource-version for concurrency

    		 query @@ -78630,42 +88072,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkInstanceGroupsInstanceGroup.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - nf-role + id -

    role in the network that this model will be providing

    +

    Instance Group ID, UUID assigned to this instance.

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - +
    - nf-naming-code + id -

    string assigned to this model used for naming purposes

    +

    Instance Group ID, UUID assigned to this instance.

    		querypath 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

    @@ -78688,7 +88308,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vf-modules + /ipsec-configurations
    @@ -78716,17 +88336,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vf-module
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    returns ipsec-configuration
    +

    GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    Tags: Network
    -

    returns vf-module

    +

    returns ipsec-configuration

    @@ -78743,10 +88363,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + ipsec-configuration-id -

    Unique id of VNF. This is unique across the graph.

    +

    UUID of this configuration

    		 path @@ -78757,12 +88377,108 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)

    +

    +
    +
    +
    +
    + /ipsec-configuration +
    +
    +
    +
    +
    + + + + + + + + + + + + +
    - vf-module-id + ipsec-configuration-id -

    Unique ID of vf-module.

    +

    UUID of this configuration

    		 path @@ -78773,42 +88489,178 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - vnf-name + ipsec-configuration-id -

    Name of VNF.

    +

    UUID of this configuration

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - + + +
    - vnf-name2 + ipsec-configuration-id -

    Alternate name of VNF.

    +

    UUID of this configuration

    		querypath string +
    - vnf-type + resource-version -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    resource-version for concurrency

    		 query @@ -78816,44 +88668,690 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + +
    - service-id + ipsec-configuration-id -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    UUID of this configuration

    		querypath 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 +

    +
    +
    + + + + + + + + + + + + - + + +
    - regional-resource-zone + ipsec-configuration-id -

    Regional way of organizing pservers, source of truth should define values

    +

    UUID of this configuration

    		querypath 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

    + +
    +
    + + + + + + + + + + + + + + + + +
    - prov-status + ipsec-configuration-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    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/v11/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 @@ -78861,14 +89359,349 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + +
    + ipsec-configuration-id + +

    UUID of this configuration

    +     		path + string + + +
    - heat-stack-id + vig-address-type -

    Heat stack id corresponding to this instance, managed by MSO

    +

    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 @@ -78880,13 +89713,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + network-role +

    Role the network plans - who defines these values?

    		 query - boolean + string @@ -78894,13 +89728,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + service-id +

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    		 query - boolean + string @@ -78908,10 +89743,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + heat-stack-id -

    the ASDC model id for this resource or service model.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -78923,10 +89758,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + contrail-network-fqdn -

    the ASDC model version for this resource or service model.

    +

    Contrail FQDN for the network

    		 query @@ -78938,10 +89773,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + model-invariant-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    the ASDC model id for this resource or service model.

    		 query @@ -78953,10 +89788,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + model-version-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    the ASDC model version for this resource or service model.

    		 query @@ -78968,10 +89803,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-type + widget-model-id -

    Generic description of the type of NF

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -78983,25 +89818,6951 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nf-function + widget-model-version -

    English description of Network function that the specific VNF deployment is providing

    +

    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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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

    		querypath string +
    - nf-role + resource-version -

    role in the network that this model will be providing

    +

    resource-version for concurrency

    		 query @@ -79009,59 +96770,317 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkNetworkPoliciesNetworkPolicy.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - nf-naming-code + network-policy-id -

    string assigned to this model used for naming purposes

    +

    UUID representing unique key to this instance

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - + + +
    - vf-module-name + network-policy-id -

    Name of vf-module

    +

    UUID representing unique key to this instance

    		querypath 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

    + +
    +
    + + + + + + + + + + + - + - - - - - - -
    - heat-stack-id + vnf-id2 -

    Heat stack id corresponding to this instance.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		querypath string +
    - model-invariant-id + vnf-name -

    the ASDC model id for this resource or service model.

    +

    Name of VNF.

    		 query @@ -79073,10 +97092,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + vnf-name2 -

    the ASDC model version for this resource or service model.

    +

    Alternate name of VNF.

    		 query @@ -79088,10 +97107,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vnf-type -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -79103,10 +97122,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + prov-status -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -79118,10 +97137,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-service-instance-fqdn + heat-stack-id -

    the Contrail unique ID for a service-instance

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -79157,7 +97176,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vf-module + /newvce
    @@ -79185,17 +97204,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vf-module
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    create or update an existing newvce
    +

    PUT /network/newvces/newvce/{vnf-id2}

    Tags: Network
    -

    create or update an existing vf-module

    +

    create or update an existing newvce

    @@ -79204,13 +97223,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vf-module object that needs to be created or updated

    +

    newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)

    - /vf-module + /newvce
    @@ -79229,26 +97248,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - vf-module-id + vnf-id2 -

    Unique ID of vf-module.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -79290,23 +97293,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vf-module
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    update an existing newvce
    +

    PATCH /network/newvces/newvce/{vnf-id2}

    Tags: Network
    -

    delete an existing vf-module

    +

    update an existing newvce

    application/json application/xml

    +
    +
    +

    newvce object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /newvce +
    +
    +
    @@ -79322,26 +97337,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - vf-module-id + vnf-id2 -

    Unique ID of vf-module.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -79352,22 +97351,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -79399,35 +97382,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    +
    delete an existing newvce
    +

    DELETE /network/newvces/newvce/{vnf-id2}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing newvce

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -79443,10 +97414,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + vnf-id2 -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -79459,12 +97430,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-id + resource-version -

    Unique ID of vf-module.

    +

    resource-version for concurrency

    		pathquery string @@ -79504,24 +97475,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -79536,10 +97502,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + vnf-id2 -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -79552,65 +97518,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-id + vnf-name -

    Unique ID of vf-module.

    +

    Name of VNF.

    		pathquery + 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 -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns instance-groups
    -

    GET /network/instance-groups

    - Tags: - Network -
    -
    -
    -

    returns instance-groups

    - -
    -

    application/json application/xml

    @@ -79633,7 +97617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /instance-groups + /l-interfaces
    @@ -79661,17 +97645,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns instance-group
    -

    GET /network/instance-groups/instance-group/{id}

    +
    returns l-interface
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    returns instance-group

    +

    returns l-interface

    @@ -79688,10 +97672,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - id + vnf-id2 -

    Instance Group ID, UUID assigned to this instance.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -79704,10 +97688,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - description + interface-name -

    Descriptive text to help identify the usage of this instance-group

    +

    Name given to the interface

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -79719,10 +97719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - type + vnf-name2 -

    Only valid value today is lower case ha for high availability

    +

    Alternate name of VNF.

    		 query @@ -79734,10 +97734,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - sub-type + vnf-type -

    Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -79773,7 +97848,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /instance-group + /l-interface
    @@ -79801,17 +97876,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing instance-group
    -

    PUT /network/instance-groups/instance-group/{id}

    +
    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 instance-group

    +

    create or update an existing l-interface

    @@ -79820,13 +97895,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    instance-group object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)

    - /instance-group + /l-interface
    @@ -79845,10 +97920,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - id + vnf-id2 -

    Instance Group ID, UUID assigned to this instance.

    +

    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 @@ -79890,23 +97981,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing instance-group
    -

    DELETE /network/instance-groups/instance-group/{id}

    +
    update an existing l-interface
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    delete an existing instance-group

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -79922,10 +98025,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - id + vnf-id2 -

    Instance Group ID, UUID assigned to this instance.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -79938,12 +98041,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -79983,35 +98086,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

    +
    delete an existing l-interface
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -80027,142 +98118,325 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    - id + 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 -

    Instance Group ID, UUID assigned to this instance.

    +

    Neutron network id of the interface that address belongs to

    		pathquery 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 + neutron-subnet-id -

    Instance Group ID, UUID assigned to this instance.

    +

    Neutron id of subnet that address belongs to

    		pathquery 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

    @@ -80185,7 +98459,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ipsec-configurations + /l3-interface-ipv4-address-list
    @@ -80213,19 +98487,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns ipsec-configuration
    -

    GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    +
    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
    -

    returns ipsec-configuration

    +

    create or update an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    @@ -80240,10 +98531,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    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 @@ -80263,29 +98586,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /ipsec-configuration -
    -
    -
    - -
    default @@ -80308,17 +98608,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing ipsec-configuration
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    +
    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
    -

    create or update an existing ipsec-configuration

    +

    update an existing l3-interface-ipv4-address-list

    @@ -80327,13 +98627,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ipsec-configuration object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    - /ipsec-configuration + /l3-interface-ipv4-address-list
    @@ -80352,10 +98652,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    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 @@ -80397,17 +98729,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing ipsec-configuration
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    +
    delete an existing 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 ipsec-configuration

    +

    delete an existing l3-interface-ipv4-address-list

    @@ -80429,10 +98761,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    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 @@ -80490,11 +98854,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -80509,7 +98873,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -80534,10 +98898,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    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 @@ -80579,11 +98975,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -80611,10 +99007,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    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 @@ -80656,17 +99084,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vig-servers
    -

    GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

    +
    returns 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 vig-servers

    +

    returns l3-interface-ipv6-address-list

    @@ -80683,10 +99111,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    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 @@ -80697,6 +99157,171 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + 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 + + +
    @@ -80723,7 +99348,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vig-servers + /l3-interface-ipv6-address-list
    @@ -80751,19 +99376,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vig-server
    -

    GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    +
    create or update an existing l3-interface-ipv6-address-list
    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    returns vig-server

    +

    create or update an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    @@ -80778,10 +99420,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -80794,10 +99436,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -80817,29 +99475,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vig-server -
    -
    -
    - -
    default @@ -80862,17 +99497,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vig-server
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    +
    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
    -

    create or update an existing vig-server

    +

    update an existing l3-interface-ipv6-address-list

    @@ -80881,13 +99516,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vig-server object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /vig-server + /l3-interface-ipv6-address-list
    @@ -80906,10 +99541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -80922,10 +99557,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -80967,17 +99618,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vig-server
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    +
    delete an existing 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 vig-server

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -80999,10 +99650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -81015,10 +99666,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -81076,11 +99743,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -81095,7 +99762,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -81120,10 +99787,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -81136,10 +99803,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -81181,11 +99864,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -81213,10 +99896,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id2 -

    UUID of this configuration

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -81229,10 +99912,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -81274,83 +99973,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-networks
    -

    GET /network/l3-networks

    +
    see node definition for valid relationships
    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    returns l3-networks

    +

    see node definition for valid relationships

    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-networks -
    -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)

    +

    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns l3-network
    -

    GET /network/l3-networks/l3-network/{network-id}

    - Tags: - Network -
    -
    -
    -

    returns l3-network

    - -
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -81365,10 +100017,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -81523,29 +100056,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-network -
    -
    -
    - -
    default @@ -81568,35 +100078,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-network
    -

    PUT /network/l3-networks/l3-network/{network-id}

    +
    delete an existing relationship
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing l3-network

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    l3-network object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-network -
    -
    -
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -81381,137 +100033,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name - -

    Name of the network, governed by some naming convention..

    -     		query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -     		query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - contrail-network-fqdn - -

    Contrail FQDN for the network

    -     		query - string - - -
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version + interface-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name given to the interface

    		querypath string +
    @@ -81612,10 +100110,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -81626,73 +100124,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing l3-network
    -

    DELETE /network/l3-networks/l3-network/{network-id}

    - Tags: - Network -
    -
    -
    -

    delete an existing l3-network

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - -
    - network-id + interface-name -

    Network ID, should be uuid. Unique across A&AI.

    +

    Name given to the interface

    		 path @@ -81703,22 +100140,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -81750,17 +100171,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns ctag-assignments
    -

    GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

    +
    returns sriov-vfs
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: Network
    -

    returns ctag-assignments

    +

    returns sriov-vfs

    @@ -81777,10 +100198,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -81793,25 +100214,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-name -

    Name of the network, governed by some naming convention..

    +

    Name given to the interface

    		querypath string +
    - network-role + vnf-name -

    Role the network plans - who defines these values?

    +

    Name of VNF.

    		 query @@ -81823,10 +100245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-name2 -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    Alternate name of VNF.

    		 query @@ -81838,10 +100260,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vnf-type -

    Heat stack id corresponding to this instance, managed by MSO

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -81853,10 +100275,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + prov-status -

    Contrail FQDN for the network

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -81868,10 +100290,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + heat-stack-id -

    the ASDC model id for this resource or service model.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -81883,10 +100305,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-id -

    the ASDC model version for this resource or service model.

    +

    ID of interface

    		 query @@ -81898,10 +100320,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + macaddr -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    MAC address for the interface

    		 query @@ -81913,10 +100335,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + network-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name of the network

    		 query @@ -81952,7 +100374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-assignments + /sriov-vfs
    @@ -81980,17 +100402,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns ctag-assignment
    -

    GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    +
    returns sriov-vf
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    returns ctag-assignment

    +

    returns sriov-vf

    @@ -82007,10 +100429,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -82023,14 +100445,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name given to the interface

    		 path - integer + string @@ -82039,10 +100461,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + pci-id -

    Name of the network, governed by some naming convention..

    +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -82054,10 +100492,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + vnf-name2 -

    Role the network plans - who defines these values?

    +

    Alternate name of VNF.

    		 query @@ -82069,10 +100507,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-type -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -82099,10 +100552,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + interface-id -

    Contrail FQDN for the network

    +

    ID of interface

    		 query @@ -82114,10 +100567,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -82129,10 +100582,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -82144,10 +100597,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vf-vlan-filter -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query @@ -82159,10 +100612,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vf-mac-filter -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    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 @@ -82198,7 +100681,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-assignment + /sriov-vf
    @@ -82226,17 +100709,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing ctag-assignment
    -

    PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    +
    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 ctag-assignment

    +

    create or update an existing sriov-vf

    @@ -82245,13 +100728,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-assignment object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /ctag-assignment + /sriov-vf
    @@ -82270,10 +100753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -82286,14 +100769,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name given to the interface

    		 path - integer + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string @@ -82331,23 +100830,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing ctag-assignment
    -

    DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    +
    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
    -

    delete an existing ctag-assignment

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -82363,10 +100874,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -82379,14 +100890,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name given to the interface

    		 path - integer + string @@ -82395,12 +100906,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -82440,35 +100951,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -82484,10 +100983,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -82500,87 +100999,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name given to the interface

    		 path - integer + string
    -
    - -
    -

    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 + pci-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -82593,14 +101031,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + resource-version -

    id.

    +

    resource-version for concurrency

    		pathquery - integer + string @@ -82638,11 +101076,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -82657,7 +101095,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -82682,10 +101120,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    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 @@ -82727,11 +101197,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -82759,10 +101229,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    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 @@ -82804,17 +101306,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns segmentation-assignments
    -

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

    +
    returns vlans
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns segmentation-assignments

    +

    returns vlans

    @@ -82831,10 +101333,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -82847,25 +101349,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-name -

    Name of the network, governed by some naming convention..

    +

    Name given to the interface

    		querypath string +
    - network-role + vnf-name -

    Role the network plans - who defines these values?

    +

    Name of VNF.

    		 query @@ -82877,10 +101380,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-name2 -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    Alternate name of VNF.

    		 query @@ -82892,10 +101395,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vnf-type -

    Heat stack id corresponding to this instance, managed by MSO

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -82907,10 +101410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + prov-status -

    Contrail FQDN for the network

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -82922,10 +101425,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + heat-stack-id -

    the ASDC model id for this resource or service model.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -82937,10 +101440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-id -

    the ASDC model version for this resource or service model.

    +

    ID of interface

    		 query @@ -82952,10 +101455,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + macaddr -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    MAC address for the interface

    		 query @@ -82967,10 +101470,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + network-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name of the network

    		 query @@ -83006,7 +101509,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /segmentation-assignments + /vlans
    @@ -83034,17 +101537,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns segmentation-assignment
    -

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    +
    returns vlan
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    returns segmentation-assignment

    +

    returns vlan

    @@ -83061,10 +101564,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -83077,10 +101580,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name given to the interface

    		 path @@ -83093,10 +101596,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vlan-interface -

    Name of the network, governed by some naming convention..

    +

    String that identifies the interface

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -83108,10 +101627,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + vnf-name2 -

    Role the network plans - who defines these values?

    +

    Alternate name of VNF.

    		 query @@ -83123,10 +101642,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-type -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -83153,10 +101687,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + interface-id -

    Contrail FQDN for the network

    +

    ID of interface

    		 query @@ -83168,10 +101702,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -83183,10 +101717,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -83198,14 +101732,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vlan-id-inner -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Inner VLAN tag

    		 query - string + integer @@ -83213,10 +101747,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vpn-key -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -83252,7 +101786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /segmentation-assignment + /vlan
    @@ -83280,17 +101814,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing segmentation-assignment
    -

    PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    +
    create or update an existing vlan
    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    create or update an existing segmentation-assignment

    +

    create or update an existing vlan

    @@ -83299,13 +101833,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    segmentation-assignment object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

    - /segmentation-assignment + /vlan
    @@ -83324,10 +101858,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -83340,10 +101874,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -83385,23 +101935,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing segmentation-assignment
    -

    DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    +
    update an existing vlan
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    delete an existing segmentation-assignment

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -83417,10 +101979,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -83433,10 +101995,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name given to the interface

    		 path @@ -83449,12 +102011,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath string @@ -83494,35 +102056,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

    +
    delete an existing vlan
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -83538,10 +102088,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -83554,10 +102104,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name given to the interface

    		 path @@ -83568,73 +102118,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + vlan-interface -

    Network ID, should be uuid. Unique across A&AI.

    +

    String that identifies the interface

    		 path @@ -83647,12 +102136,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + resource-version -

    Route Table Reference id, UUID assigned to this instance.

    +

    resource-version for concurrency

    		pathquery string @@ -83692,17 +102181,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns subnets
    -

    GET /network/l3-networks/l3-network/{network-id}/subnets

    +
    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 subnets

    +

    returns l3-interface-ipv4-address-list

    @@ -83719,10 +102208,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -83735,100 +102224,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name - -

    Name of the network, governed by some naming convention..

    -     		query - string - - -
    - network-role - -

    Role the network plans - who defines these values?

    -     		query - string - - -
    - service-id - -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    -     		query - string - - -
    - heat-stack-id + interface-name -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Name given to the interface

    		querypath string +
    - contrail-network-fqdn + vlan-interface -

    Contrail FQDN for the network

    +

    String that identifies the interface

    		querypath string +
    - model-invariant-id + l3-interface-ipv4-address -

    the ASDC model id for this resource or service model.

    +

    IP address

    		querypath string +
    - model-version-id + vnf-name -

    the ASDC model version for this resource or service model.

    +

    Name of VNF.

    		 query @@ -83840,10 +102287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vnf-name2 -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Alternate name of VNF.

    		 query @@ -83855,10 +102302,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vnf-type -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -83868,123 +102315,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 + prov-status -

    Name of the network, governed by some naming convention..

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -83996,10 +102332,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + heat-stack-id -

    Role the network plans - who defines these values?

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -84011,10 +102347,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + interface-id -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    ID of interface

    		 query @@ -84026,10 +102362,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + macaddr -

    Heat stack id corresponding to this instance, managed by MSO

    +

    MAC address for the interface

    		 query @@ -84041,10 +102377,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + network-name -

    Contrail FQDN for the network

    +

    Name of the network

    		 query @@ -84056,14 +102392,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + vlan-id-inner -

    the ASDC model id for this resource or service model.

    +

    Inner VLAN tag

    		 query - string + integer @@ -84071,10 +102407,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + vpn-key -

    the ASDC model version for this resource or service model.

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -84086,14 +102422,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vlan-id-inner -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Inner VLAN tag

    		 query - string + integer @@ -84101,10 +102437,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + neutron-network-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -84116,10 +102452,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-name + neutron-subnet-id -

    Name associated with the subnet.

    +

    Neutron id of subnet that address belongs to

    		 query @@ -84155,7 +102491,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /subnet + /l3-interface-ipv4-address-list
    @@ -84183,17 +102519,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing subnet
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    +
    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 subnet

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -84202,13 +102538,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    subnet object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /subnet + /l3-interface-ipv4-address-list
    @@ -84227,10 +102563,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -84243,10 +102579,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -84288,23 +102656,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing subnet
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    +
    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
    -

    delete an existing subnet

    +

    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 +
    +
    +
    @@ -84320,10 +102700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -84336,10 +102716,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    		 path @@ -84352,12 +102732,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string @@ -84397,19 +102793,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns host-routes
    -

    GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

    +
    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
    -

    returns host-routes

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -84424,10 +102825,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -84440,10 +102841,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    		 path @@ -84456,40 +102857,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vlan-interface -

    Name of the network, governed by some naming convention..

    +

    String that identifies the interface

    		querypath string +
    - network-role + l3-interface-ipv4-address -

    Role the network plans - who defines these values?

    +

    IP address

    		querypath string +
    - service-id + resource-version -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    resource-version for concurrency

    		 query @@ -84497,111 +102900,269 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + + +
    - heat-stack-id + vnf-id2 -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		querypath string +
    - contrail-network-fqdn + interface-name -

    Contrail FQDN for the network

    +

    Name given to the interface

    		querypath string +
    - model-invariant-id + vlan-interface -

    the ASDC model id for this resource or service model.

    +

    String that identifies the interface

    		querypath string +
    - model-version-id + l3-interface-ipv4-address -

    the ASDC model version for this resource or service model.

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/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 +

    +
    +
    + + + + + + + + + + + - + + + + + + + + - + - + @@ -84613,29 +103174,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /host-routes -
    -
    -
    - -
    default @@ -84658,17 +103196,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns host-route
    -

    GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    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 host-route

    +

    returns l3-interface-ipv6-address-list

    @@ -84685,10 +103223,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - widget-model-id + vnf-id2 -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		querypath string +
    - widget-model-version + interface-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		querypath string +
    - subnet-name + l3-interface-ipv4-address -

    Name associated with the subnet.

    +

    IP address

    		querypath string +
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -84701,10 +103239,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    		 path @@ -84717,10 +103255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - host-route-id + vlan-interface -

    host-route id

    +

    String that identifies the interface

    		 path @@ -84733,10 +103271,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + l3-interface-ipv6-address -

    Name of the network, governed by some naming convention..

    +

    IP address

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -84748,10 +103302,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + vnf-name2 -

    Role the network plans - who defines these values?

    +

    Alternate name of VNF.

    		 query @@ -84763,10 +103317,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-type -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -84793,10 +103362,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + interface-id -

    Contrail FQDN for the network

    +

    ID of interface

    		 query @@ -84808,10 +103377,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -84823,10 +103392,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -84838,10 +103407,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vlan-id-inner -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-key + +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -84853,10 +103437,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vlan-id-inner -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -84868,10 +103467,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-name + neutron-subnet-id -

    Name associated with the subnet.

    +

    Neutron id of subnet that address belongs to

    		 query @@ -84907,7 +103506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /host-route + /l3-interface-ipv6-address-list
    @@ -84935,17 +103534,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing host-route
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    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 host-route

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -84954,13 +103553,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    host-route object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /host-route + /l3-interface-ipv6-address-list
    @@ -84979,10 +103578,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -84995,10 +103594,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    		 path @@ -85011,10 +103610,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - host-route-id + vlan-interface -

    host-route id

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -85056,23 +103671,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing host-route
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

    +
    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
    -

    delete an existing host-route

    +

    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 +
    +
    +
    @@ -85088,10 +103715,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -85104,10 +103731,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    		 path @@ -85120,10 +103747,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - host-route-id + vlan-interface -

    host-route id

    +

    String that identifies the interface

    		 path @@ -85136,12 +103763,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -85181,35 +103808,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -85225,26 +103840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - -
    - network-id - -

    Network ID, should be uuid. Unique across A&AI.

    -     		path - string - - - -
    - subnet-id + vnf-id2 -

    Subnet ID, should be UUID.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -85257,10 +103856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - host-route-id + interface-name -

    host-route id

    +

    Name given to the interface

    		 path @@ -85271,73 +103870,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + vlan-interface -

    Network ID, should be uuid. Unique across A&AI.

    +

    String that identifies the interface

    		 path @@ -85350,10 +103888,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + l3-interface-ipv6-address -

    Subnet ID, should be UUID.

    +

    IP address

    		 path @@ -85366,12 +103904,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - host-route-id + resource-version -

    host-route id

    +

    resource-version for concurrency

    		pathquery string @@ -85411,11 +103949,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    +

    PUT /network/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
    @@ -85430,7 +103968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -85455,10 +103993,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id2 -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -85471,10 +104009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name given to the interface

    		 path @@ -85485,73 +104023,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + vlan-interface -

    Network ID, should be uuid. Unique across A&AI.

    +

    String that identifies the interface

    		 path @@ -85564,10 +104041,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + l3-interface-ipv6-address -

    Subnet ID, should be UUID.

    +

    IP address

    		 path @@ -85609,83 +104086,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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
    -

    returns lag-link

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -85700,10 +104118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - link-name + vnf-id2 -

    Alphabetical concatenation of lag-interface names

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -85714,108 +104132,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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

    -

    -
    -
    -
    -
    - /lag-link -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - link-name + interface-name -

    Alphabetical concatenation of lag-interface names

    +

    Name given to the interface

    		 path @@ -85826,73 +104148,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing lag-link
    -

    DELETE /network/lag-links/lag-link/{link-name}

    - Tags: - Network -
    -
    -
    -

    delete an existing lag-link

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - link-name + vlan-interface -

    Alphabetical concatenation of lag-interface names

    +

    String that identifies the interface

    		 path @@ -85905,12 +104166,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -85950,11 +104211,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: Network
    @@ -85969,7 +104230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

    @@ -85994,10 +104255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id2 -

    Alphabetical concatenation of lag-interface names

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -86008,73 +104269,28 @@ 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/lag-links/lag-link/{link-name}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - + + + + + + +
    - link-name + interface-name -

    Alphabetical concatenation of lag-interface names

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -86116,83 +104332,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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
    -

    returns logical-link

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -86207,10 +104364,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -86350,29 +104419,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /logical-link -
    -
    -
    - -
    default @@ -86395,17 +104441,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing logical-link
    -

    PUT /network/logical-links/logical-link/{link-name}

    +
    see node definition for valid relationships
    +

    PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing logical-link

    +

    see node definition for valid relationships

    @@ -86414,13 +104460,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    logical-link object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)

    - /logical-link + /relationship
    @@ -86439,10 +104485,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - link-name + vnf-id2 -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -86223,122 +104380,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - model-version-id - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id - -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -     		query - string - - -
    - widget-model-version - -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - link-id - -

    UUID of the logical-link, SDNC generates this.

    -     		query - string - - -
    - circuit-id + interface-name -

    Circuit id

    +

    Name given to the interface

    		querypath string +
    - purpose + vlan-interface -

    Reason for this entity, role it is playing

    +

    String that identifies the interface

    		querypath string +
    - link-name + vnf-id2 -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -86484,17 +104530,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing logical-link
    -

    DELETE /network/logical-links/logical-link/{link-name}

    +
    delete an existing relationship
    +

    DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    Tags: Network
    -

    delete an existing logical-link

    +

    delete an existing relationship

    @@ -86516,10 +104562,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id2 -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -86530,22 +104576,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -86577,73 +104607,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

    +
    returns physical-links
    +

    GET /network/physical-links

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns physical-links

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - - -
    - link-name - -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    -     		path - string - - - -
    -

    application/json application/xml

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /physical-links +
    +
    +
    + +
    default @@ -86666,24 +104671,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

    +
    returns physical-link
    +

    GET /network/physical-links/physical-link/{link-name}

    Tags: Network
    -

    delete an existing relationship

    +

    returns physical-link

    -
    - -

    application/json application/xml -

    -
    @@ -86701,7 +104701,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen link-name + + + + + + +
    -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -86712,51 +104712,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + circuit-id + +

    Circuit it

    +     		query + 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

    @@ -86779,7 +104753,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /multicast-configurations + /physical-link
    @@ -86807,19 +104781,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns multicast-configuration
    -

    GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    +
    create or update an existing physical-link
    +

    PUT /network/physical-links/physical-link/{link-name}

    Tags: Network
    -

    returns multicast-configuration

    +

    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/v11/NetworkPhysicalLinksPhysicalLink.json)

    +

    +
    +
    +
    +
    + /physical-link +
    +
    +
    +
    @@ -86834,10 +104825,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + + + + + + + + + + + + + + - - - - - - - - + - - - - - - - - + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - multicast-configuration-id + link-name -

    Unique id of multicast configuration.

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -86857,29 +104848,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /multicast-configuration -
    -
    -
    - -
    default @@ -86902,17 +104870,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing multicast-configuration
    -

    PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    +
    update an existing physical-link
    +

    PATCH /network/physical-links/physical-link/{link-name}

    Tags: Network
    -

    create or update an existing multicast-configuration

    +

    update an existing physical-link

    @@ -86921,13 +104889,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    multicast-configuration object that needs to be created or updated

    +

    physical-link object that needs to be created or updated.

    - /multicast-configuration + /physical-link
    @@ -86946,10 +104914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - multicast-configuration-id + link-name -

    Unique id of multicast configuration.

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -86991,17 +104959,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing multicast-configuration
    -

    DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    +
    delete an existing physical-link
    +

    DELETE /network/physical-links/physical-link/{link-name}

    Tags: Network
    -

    delete an existing multicast-configuration

    +

    delete an existing physical-link

    @@ -87023,10 +104991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - multicast-configuration-id + link-name -

    Unique id of multicast configuration.

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -87084,11 +105052,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

    +

    PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

    Tags: Network
    @@ -87103,7 +105071,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)

    @@ -87128,10 +105096,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - multicast-configuration-id + link-name -

    Unique id of multicast configuration.

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -87173,11 +105141,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

    +

    DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

    Tags: Network
    @@ -87205,10 +105173,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - multicast-configuration-id + link-name -

    Unique id of multicast configuration.

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -87250,17 +105218,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns network-policies
    -

    GET /network/network-policies

    +
    returns pnfs
    +

    GET /network/pnfs

    Tags: Network
    -

    returns network-policies

    +

    returns pnfs

    @@ -87286,7 +105254,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-policies + /pnfs
    @@ -87314,17 +105282,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns network-policy
    -

    GET /network/network-policies/network-policy/{network-policy-id}

    +
    returns pnf
    +

    GET /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    returns network-policy

    +

    returns pnf

    @@ -87341,10 +105309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-id + pnf-name -

    UUID representing unique key to this instance

    +

    unique name of Physical Network Function.

    		 path @@ -87357,10 +105325,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-fqdn + inv-status -

    Contrail FQDN for the policy

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -87396,7 +105364,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-policy + /pnf
    @@ -87424,17 +105392,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing network-policy
    -

    PUT /network/network-policies/network-policy/{network-policy-id}

    +
    create or update an existing pnf
    +

    PUT /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    create or update an existing network-policy

    +

    create or update an existing pnf

    @@ -87443,13 +105411,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-policy object that needs to be created or updated

    +

    pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)

    - /network-policy + /pnf
    @@ -87468,10 +105436,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-id + pnf-name -

    UUID representing unique key to this instance

    +

    unique name of Physical Network Function.

    		 path @@ -87513,23 +105481,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing network-policy
    -

    DELETE /network/network-policies/network-policy/{network-policy-id}

    +
    update an existing pnf
    +

    PATCH /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    delete an existing network-policy

    +

    update an existing pnf

    application/json application/xml

    +
    +
    +

    pnf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /pnf +
    +
    +
    @@ -87545,10 +105525,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - network-policy-id + pnf-name -

    UUID representing unique key to this instance

    +

    unique name of Physical Network Function.

    		 path @@ -87559,22 +105539,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -87606,35 +105570,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

    +
    delete an existing pnf
    +

    DELETE /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing pnf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -87650,10 +105602,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - network-policy-id + pnf-name -

    UUID representing unique key to this instance

    +

    unique name of Physical Network Function.

    		 path @@ -87664,6 +105616,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -87695,24 +105663,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

    +
    returns lag-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns lag-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -87727,10 +105690,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - network-policy-id + pnf-name -

    UUID representing unique key to this instance

    +

    unique name of Physical Network Function.

    		 path @@ -87741,51 +105704,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns newvces
    -

    GET /network/newvces

    - Tags: - Network -
    -
    -
    -

    returns newvces

    - -
    -

    application/json application/xml

    @@ -87808,7 +105745,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /newvces + /lag-interfaces
    @@ -87836,17 +105773,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns newvce
    -

    GET /network/newvces/newvce/{vnf-id2}

    +
    returns lag-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    returns newvce

    +

    returns lag-interface

    @@ -87863,10 +105800,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -87879,40 +105816,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -87924,10 +105847,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -87939,10 +105862,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -87978,7 +105901,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /newvce + /lag-interface
    @@ -88006,17 +105929,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    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/v11/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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    -
    create or update an existing newvce
    -

    PUT /network/newvces/newvce/{vnf-id2}

    +
    update an existing lag-interface
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    create or update an existing newvce

    +

    update an existing lag-interface

    @@ -88025,13 +106053,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    newvce object that needs to be created or updated

    +

    lag-interface object that needs to be created or updated.

    - /newvce + /lag-interface
    @@ -88050,10 +106078,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -88095,17 +106139,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing newvce
    -

    DELETE /network/newvces/newvce/{vnf-id2}

    +
    delete an existing lag-interface
    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing newvce

    +

    delete an existing lag-interface

    @@ -88127,10 +106171,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -88188,11 +106248,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l-interfaces
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces

    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: Network
    @@ -88215,10 +106275,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -88231,40 +106291,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -88276,10 +106322,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -88291,10 +106337,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -88330,7 +106376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -88358,11 +106404,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l-interface
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    @@ -88385,10 +106431,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -88404,7 +106450,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 @@ -88417,40 +106463,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name given to the interface

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -88462,10 +106494,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -88477,10 +106509,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -88561,7 +106593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -88589,17 +106621,138 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    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/v11/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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    -
    create or update an existing l-interface
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    create or update an existing l-interface

    +

    update an existing l-interface

    @@ -88608,13 +106761,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

    +

    l-interface object that needs to be created or updated.

    - /l-interface + /l-interface
    @@ -88633,10 +106786,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -88694,11 +106863,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing l-interface
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    @@ -88726,10 +106895,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -88803,11 +106988,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv4-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -88830,10 +107015,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -88849,7 +107034,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 @@ -88862,10 +107047,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 @@ -88878,40 +107063,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + l3-interface-ipv4-address -

    Alternate name of VNF.

    +

    IP address

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -88923,10 +107094,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -88938,10 +107109,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -89067,7 +107238,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -89095,11 +107266,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -89114,7 +107285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -89139,10 +107310,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    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 @@ -89216,11 +107540,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -89248,10 +107572,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -89341,11 +107681,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    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
    @@ -89360,7 +107700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -89385,10 +107725,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -89462,11 +107818,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
    @@ -89494,10 +107850,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -89571,11 +107943,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv6-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -89598,10 +107970,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -89617,7 +107989,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 @@ -89630,10 +108002,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 @@ -89646,40 +108018,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + l3-interface-ipv6-address -

    Alternate name of VNF.

    +

    IP address

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -89691,10 +108049,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -89706,10 +108064,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -89835,7 +108193,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -89863,11 +108221,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -89882,7 +108240,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -89907,10 +108265,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -89984,11 +108358,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    + 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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -90016,10 +108527,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -90109,35 +108636,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    + 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/v11/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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    -
    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

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -90153,10 +108805,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - -
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -90172,100 +108824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-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

    +

    Name that identifies the link aggregate interface

    		 path @@ -90339,11 +108898,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -90358,7 +108917,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -90383,10 +108942,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -90444,11 +109019,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -90476,10 +109051,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -90537,11 +109128,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns sriov-vfs
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: Network
    @@ -90564,10 +109155,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -90583,7 +109174,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 @@ -90596,40 +109187,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name given to the interface

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -90641,10 +109218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -90656,10 +109233,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -90740,7 +109317,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -90768,11 +109345,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns sriov-vf
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +

    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
    @@ -90795,10 +109372,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -90814,7 +109391,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 @@ -90827,10 +109404,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 @@ -90843,40 +109420,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + pci-id -

    Alternate name of VNF.

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -90888,10 +109451,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -90903,10 +109466,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -91047,7 +109610,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -91075,11 +109638,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +

    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
    @@ -91094,7 +109657,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -91119,10 +109682,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -91196,11 +109775,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing sriov-vf
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + 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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +

    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
    @@ -91228,10 +109944,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -91321,11 +110053,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/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
    @@ -91340,7 +110072,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -91365,10 +110097,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -91442,11 +110190,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/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
    @@ -91474,10 +110222,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -91551,11 +110315,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns vlans
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    @@ -91578,10 +110342,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -91597,7 +110361,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 @@ -91610,40 +110374,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name given to the interface

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -91655,10 +110405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -91670,10 +110420,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -91754,7 +110504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -91782,11 +110532,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns vlan
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    @@ -91809,10 +110559,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -91828,7 +110578,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 @@ -91841,10 +110591,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 @@ -91857,40 +110607,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + vlan-interface -

    Alternate name of VNF.

    +

    String that identifies the interface

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -91902,10 +110638,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -91917,10 +110653,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -92031,7 +110767,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -92059,11 +110795,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    create or update an existing vlan
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    @@ -92078,7 +110814,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -92103,10 +110839,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -92180,11 +110932,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing vlan
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + 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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    @@ -92212,10 +111101,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -92305,11 +111210,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv4-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -92332,10 +111237,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -92396,40 +111317,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 + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -92441,10 +111332,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -92456,10 +111347,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -92615,7 +111506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -92643,11 +111534,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -92662,7 +111553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -92687,10 +111578,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -92780,11 +111687,164 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -92812,10 +111872,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -92921,11 +111997,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    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
    @@ -92940,7 +112016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -92965,10 +112041,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -93058,11 +112150,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
    @@ -93090,10 +112182,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -93183,11 +112291,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv6-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -93210,10 +112318,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -93229,7 +112337,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 @@ -93242,10 +112350,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 @@ -93258,10 +112366,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 @@ -93274,40 +112382,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + l3-interface-ipv6-address -

    Alternate name of VNF.

    +

    IP address

    		querypath string +
    - vnf-type + inv-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -93319,10 +112413,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -93334,10 +112428,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -93493,7 +112587,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -93521,11 +112615,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -93540,7 +112634,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -93565,10 +112659,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -93658,23 +112768,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -93690,10 +112812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -93709,7 +112831,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 @@ -93722,10 +112844,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 @@ -93738,10 +112860,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 @@ -93754,12 +112876,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -93799,35 +112921,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -93843,10 +112953,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - -
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -93862,39 +112972,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    +

    Name that identifies the link aggregate interface

    		 path @@ -93905,73 +112983,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Name given to the interface

    		 path @@ -93984,10 +113001,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -94000,10 +113017,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -94016,12 +113033,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -94061,11 +113078,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    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
    @@ -94080,7 +113097,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -94105,10 +113122,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -94124,23 +113141,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -94151,73 +113152,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Name given to the interface

    		 path @@ -94230,10 +113170,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -94246,10 +113186,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -94291,35 +113231,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -94335,10 +113263,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnf-id2 + pnf-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    unique name of Physical Network Function.

    		 path @@ -94349,73 +113277,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - -
    - vnf-id2 + interface-name -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Name that identifies the link aggregate interface

    		 path @@ -94426,132 +113293,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - - + + + + + + + + @@ -94586,29 +113350,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /physical-link -
    -
    -
    - -
    default @@ -94631,17 +113372,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing physical-link
    -

    PUT /network/physical-links/physical-link/{link-name}

    +
    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
    -

    create or update an existing physical-link

    +

    see node definition for valid relationships

    @@ -94650,13 +113391,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    physical-link object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /physical-link + /relationship
    @@ -94675,10 +113416,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    - link-name + interface-name -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Name given to the interface

    		 path @@ -94564,17 +113311,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - circuit-id + vlan-interface -

    Circuit it

    +

    String that identifies the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string +
    - link-name + pnf-name -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    unique name of Physical Network Function.

    		 path @@ -94689,73 +113430,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing physical-link
    -

    DELETE /network/physical-links/physical-link/{link-name}

    - Tags: - Network -
    -
    -
    -

    delete an existing physical-link

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - link-name + interface-name -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Name that identifies the link aggregate interface

    		 path @@ -94768,12 +113448,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -94782,85 +113462,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - link-name + vlan-interface -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    String that identifies the interface

    		 path @@ -94902,11 +113509,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/physical-links/physical-link/{link-name}/relationship-list/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
    @@ -94934,10 +113541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + pnf-name -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    unique name of Physical Network Function.

    		 path @@ -94948,132 +113555,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - - + + + + + + + + @@ -95108,29 +113612,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /pnf -
    -
    -
    - -
    default @@ -95153,17 +113634,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing pnf
    -

    PUT /network/pnfs/pnf/{pnf-name}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing pnf

    +

    see node definition for valid relationships

    @@ -95172,13 +113653,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    pnf object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)

    - /pnf + /relationship
    @@ -95211,6 +113692,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + +
    - pnf-name + interface-name -

    unique name of Physical Network Function.

    +

    Name that identifies the link aggregate interface

    		 path @@ -95086,17 +113573,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + interface-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    @@ -95242,17 +113739,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing pnf
    -

    DELETE /network/pnfs/pnf/{pnf-name}

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    delete an existing pnf

    +

    delete an existing relationship

    @@ -95290,12 +113787,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath string @@ -95335,17 +113832,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

    +
    returns p-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces

    Tags: Network
    -

    returns lag-interfaces

    +

    returns p-interfaces

    @@ -95417,7 +113914,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /p-interfaces
    @@ -95445,17 +113942,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns lag-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    returns p-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    returns lag-interface

    +

    returns p-interface

    @@ -95491,7 +113988,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 @@ -95519,25 +114016,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -95573,7 +114055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /p-interface
    @@ -95601,17 +114083,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    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 lag-interface

    +

    create or update an existing p-interface

    @@ -95620,13 +114102,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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)

    - /lag-interface + /p-interface
    @@ -95664,7 +114146,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 @@ -95706,23 +114188,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing lag-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    update an existing p-interface
    +

    PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    delete an existing lag-interface

    +

    update an existing p-interface

    application/json application/xml

    +
    +
    +

    p-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    @@ -95757,7 +114251,100 @@ 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 + 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 @@ -95815,11 +114402,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: Network
    @@ -95861,7 +114448,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 @@ -95889,25 +114476,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -95943,7 +114515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -95971,11 +114543,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    @@ -96017,7 +114589,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 @@ -96061,25 +114633,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -96160,7 +114717,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -96188,11 +114745,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    @@ -96207,7 +114764,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -96251,7 +114808,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 @@ -96309,23 +114866,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -96360,7 +114929,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 @@ -96387,22 +114956,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -96434,19 +114987,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing l-interface

    +
    + +

    application/json application/xml +

    +
    @@ -96480,7 +115038,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 @@ -96509,10 +115067,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    +     		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 @@ -96525,25 +115155,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + interface-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Name that identifies the physical interface

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    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 @@ -96555,10 +115218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -96684,7 +115347,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -96712,11 +115375,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    PUT /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
    @@ -96731,7 +115394,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -96775,7 +115438,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 @@ -96849,23 +115512,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -96900,7 +115575,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 @@ -96943,22 +115618,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -96990,35 +115649,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -97053,7 +115700,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 @@ -97096,6 +115743,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -97127,23 +115790,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -97178,7 +115853,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 @@ -97252,19 +115927,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -97298,7 +115978,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 @@ -97327,7 +116007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -97341,27 +116021,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l3-interface-ipv6-address-list
    +

    GET /network/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

    + +
    +
    + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - inv-status + pnf-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    unique name of Physical Network Function.

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name that identifies the 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 @@ -97373,10 +116158,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -97502,7 +116287,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -97530,11 +116315,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    PUT /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
    @@ -97549,7 +116334,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -97593,7 +116378,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 @@ -97667,11 +116452,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -97718,7 +116640,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 @@ -97808,11 +116730,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -97827,7 +116749,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -97871,7 +116793,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 @@ -97945,11 +116867,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -97996,7 +116918,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 @@ -98070,11 +116992,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -98089,7 +117011,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -98133,7 +117055,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 @@ -98191,11 +117113,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -98242,7 +117164,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 @@ -98300,11 +117222,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns sriov-vfs
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: Network
    @@ -98346,7 +117268,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 @@ -98390,25 +117312,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -98489,7 +117396,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -98517,11 +117424,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns sriov-vf
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +

    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
    @@ -98563,7 +117470,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 @@ -98623,25 +117530,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -98782,7 +117674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -98810,11 +117702,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +

    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
    @@ -98829,7 +117721,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -98873,7 +117765,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 @@ -98947,11 +117839,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing sriov-vf
    +

    PATCH /network/pnfs/pnf/{pnf-name}/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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +

    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
    @@ -98998,7 +118027,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 @@ -99088,11 +118117,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -99107,7 +118136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -99151,7 +118180,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 @@ -99225,11 +118254,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -99276,7 +118305,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 @@ -99350,11 +118379,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns vlans
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    @@ -99396,7 +118425,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 @@ -99440,25 +118469,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -99539,7 +118553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -99567,11 +118581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns vlan
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    @@ -99613,7 +118627,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 @@ -99673,25 +118687,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -99802,7 +118801,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -99830,11 +118829,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    create or update an existing vlan
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    @@ -99849,7 +118848,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -99893,7 +118892,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 @@ -99967,23 +118966,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -100018,7 +119029,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 @@ -100061,22 +119072,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -100108,19 +119103,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing vlan

    +
    + +

    application/json application/xml +

    +
    @@ -100154,7 +119154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -100387,29 +119222,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -100432,36 +119244,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns l3-interface-ipv4-address-list
    +

    GET /network/pnfs/pnf/{pnf-name}/p-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

    +

    returns 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 -
    -
    -
    -
    -

    Name that identifies the link aggregate interface

    +

    Name that identifies the physical interface

    		 path @@ -100199,176 +119199,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -100376,6 +119210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -100495,7 +119290,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 @@ -100554,153 +119349,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -100720,6 +119508,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -100742,17 +119553,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -100761,13 +119572,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /relationship + /l3-interface-ipv4-address-list
    @@ -100805,7 +119616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - pnf-name + inv-status -

    unique name of Physical Network Function.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - interface-name + prov-status -

    Name that identifies the link aggregate interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - interface-name + interface-id -

    Name given to the interface

    +

    ID of interface

    		pathquery string -
    - vlan-interface + macaddr -

    String that identifies the interface

    +

    MAC address for the interface

    		pathquery string -
    - l3-interface-ipv4-address + network-name -

    IP address

    +

    Name of the network

    		pathquery string -
    - resource-version + vlan-id-inner -

    resource-version for concurrency

    +

    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 @@ -100708,7 +119497,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -

    Name that identifies the link aggregate interface

    +

    Name that identifies the physical interface

    		 path @@ -100895,23 +119706,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/p-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 relationship

    +

    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 +
    +
    +
    @@ -100946,7 +119769,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 @@ -101036,19 +119859,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -101082,7 +119910,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 @@ -101127,7 +119955,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -101143,55 +119971,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - 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 + resource-version -

    ID of interface

    +

    resource-version for concurrency

    		 query @@ -101199,111 +119982,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /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/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - - - - - - - - + - - - - - - - - + - + @@ -101315,29 +120147,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv6-address-list -
    -
    -
    - -
    default @@ -101360,35 +120169,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/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 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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    - macaddr + pnf-name -

    MAC address for the interface

    +

    unique name of Physical Network Function.

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name that identifies the physical interface

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-key + interface-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name given to the interface

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id + vlan-interface -

    Neutron network id of the interface that address belongs to

    +

    String that identifies the interface

    		querypath string +
    - neutron-subnet-id + l3-interface-ipv4-address -

    Neutron id of subnet that address belongs to

    +

    IP address

    		querypath string +
    @@ -101423,7 +120220,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 @@ -101468,7 +120265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -101513,24 +120310,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -101564,7 +120356,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -101648,6 +120574,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -101670,17 +120619,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -101689,13 +120638,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /relationship + /l3-interface-ipv6-address-list
    @@ -101733,7 +120682,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 @@ -101625,10 +120417,145 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + inv-status -

    resource-version for concurrency

    +

    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 @@ -101636,7 +120563,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -

    Name that identifies the link aggregate interface

    +

    Name that identifies the physical interface

    		 path @@ -101823,23 +120772,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    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 +
    +
    +
    @@ -101874,7 +120835,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 @@ -101964,35 +120925,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -102027,7 +120976,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 @@ -102070,6 +121019,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -102101,23 +121082,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -102152,7 +121145,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 @@ -102195,6 +121188,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -102226,35 +121235,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -102289,7 +121286,55 @@ 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 + 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 @@ -102331,23 +121376,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -102382,7 +121439,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 @@ -102393,68 +121450,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns p-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces

    - Tags: - Network -
    -
    -
    -

    returns p-interfaces

    - -
    -
    - - - - - - - - - - - - + @@ -102489,29 +121491,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interfaces -
    -
    -
    - -
    default @@ -102534,19 +121513,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    returns p-interface

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - pnf-name + interface-name -

    unique name of Physical Network Function.

    +

    Name given to the interface

    		 path @@ -102467,17 +121468,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vlan-interface -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String that identifies the interface

    		querypath string +
    @@ -102593,66 +121577,45 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - +
    - inv-status + interface-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Name given to the interface

    		querypath string +
    - prov-status + vlan-interface -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    String that identifies the interface

    		querypath string +
    -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interface -
    -
    -
    - -
    +
    +

    application/json application/xml +

    + +
    default @@ -102675,17 +121638,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing p-interface
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing p-interface

    +

    see node definition for valid relationships

    @@ -102694,13 +121657,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)

    - /p-interface + /relationship
    @@ -102780,17 +121743,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing p-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    delete an existing p-interface

    +

    delete an existing relationship

    @@ -102842,22 +121805,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -102889,17 +121836,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    returns sriov-pfs
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

    Tags: Network
    -

    returns l-interfaces

    +

    returns sriov-pfs

    @@ -103002,7 +121949,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /sriov-pfs
    @@ -103030,17 +121977,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    returns sriov-pf

    @@ -103089,10 +122036,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + pf-pci-id -

    Name given to the interface

    +

    Identifier for the sriov-pf

    		 path @@ -103133,51 +122080,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -103204,7 +122106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /sriov-pf
    @@ -103232,17 +122134,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing sriov-pf

    @@ -103251,13 +122153,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

    - /l-interface + /sriov-pf
    @@ -103308,10 +122210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + pf-pci-id -

    Name given to the interface

    +

    Identifier for the sriov-pf

    		 path @@ -103353,23 +122255,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    update an existing sriov-pf

    application/json application/xml

    +
    +
    +

    sriov-pf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-pf +
    +
    +
    @@ -103417,10 +122331,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - interface-name + pf-pci-id -

    Name given to the interface

    +

    Identifier for the sriov-pf

    		 path @@ -103431,22 +122345,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -103478,19 +122376,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing sriov-pf

    +
    + +

    application/json application/xml +

    +
    @@ -103537,26 +122440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -103696,29 +122479,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -103741,17 +122501,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -103760,13 +122520,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

    - /l3-interface-ipv4-address-list + /relationship
    @@ -103817,26 +122577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pf-pci-id -

    IP address

    +

    Identifier for the sriov-pf

    		 path @@ -103569,115 +122456,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - 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 + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -103685,6 +122467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pf-pci-id -

    IP address

    +

    Identifier for the sriov-pf

    		 path @@ -103878,17 +122622,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/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 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 l3-interface-ipv4-address-list

    +

    delete an existing relationship

    @@ -103942,26 +122686,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pf-pci-id -

    IP address

    +

    Identifier for the sriov-pf

    		 path @@ -103972,22 +122700,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -104019,11 +122731,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    Tags: Network
    @@ -104038,7 +122750,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)

    @@ -104077,54 +122789,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -104156,11 +122820,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    Tags: Network
    @@ -104202,54 +122866,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -104281,218 +122897,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns route-table-references
    +

    GET /network/route-table-references

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns route-table-references

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -104516,7 +122933,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /l3-interface-ipv6-address-list + /route-table-references
    @@ -104544,36 +122961,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns route-table-reference
    +

    GET /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns route-table-reference

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -104588,42 +122988,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -104659,6 +123026,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /route-table-reference +
    +
    +
    + +
    default @@ -104681,23 +123071,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 route-table-reference
    +

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v11/NetworkRouteTableReferencesRouteTableReference.json)

    +

    +
    +
    +
    +
    + /route-table-reference +
    +
    +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + route-table-reference-id -

    Name given to the interface

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -104636,18 +123004,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + route-table-reference-fqdn -

    IP address

    +

    FQDN entry in the route table.

    		pathquery string -
    @@ -104713,58 +123115,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 + route-table-reference-id -

    IP address

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -104775,22 +123129,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -104822,17 +123160,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing route-table-reference
    +

    PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing route-table-reference

    @@ -104841,13 +123179,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

    +

    route-table-reference object that needs to be created or updated.

    - /relationship + /route-table-reference
    @@ -104866,58 +123204,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + route-table-reference-id -

    IP address

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -104959,74 +123249,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing route-table-reference
    +

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing route-table-reference

    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - + +

    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 + route-table-reference-id -

    Name given to the interface

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -105039,12 +123297,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -105084,11 +123342,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    Tags: Network
    @@ -105103,7 +123361,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)

    @@ -105128,42 +123386,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + route-table-reference-id -

    Name given to the interface

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -105205,11 +123431,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    Tags: Network
    @@ -105237,42 +123463,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + route-table-reference-id -

    Name given to the interface

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -105314,157 +123508,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    returns site-pair-sets
    +

    GET /network/site-pair-sets

    Tags: Network
    -

    returns sriov-vfs

    +

    returns site-pair-sets

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -105488,7 +123544,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /sriov-vfs + /site-pair-sets
    @@ -105516,17 +123572,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    returns site-pair-set
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    returns sriov-vf

    +

    returns site-pair-set

    @@ -105543,58 +123599,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + site-pair-set-id -

    PCI ID used to identify the sriov-vf

    +

    Unique id of site pair set.

    		 path @@ -105605,141 +123613,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vf-vlan-filter - -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    -     		query - string - - -
    - vf-mac-filter - -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    -     		query - string - - -
    - vf-vlan-strip - -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    -     		query - boolean - - -
    - neutron-network-id - -

    Neutron network id of the interface

    -     		query - string - - -
    @@ -105766,7 +123639,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /site-pair-set
    @@ -105794,17 +123667,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/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 site-pair-set
    +

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    create or update an existing sriov-vf

    +

    create or update an existing site-pair-set

    @@ -105813,13 +123686,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

    +

    site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)

    - /sriov-vf + /site-pair-set
    @@ -105838,58 +123711,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + site-pair-set-id -

    PCI ID used to identify the sriov-vf

    +

    Unique id of site pair set.

    		 path @@ -105931,23 +123756,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing site-pair-set
    +

    PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    delete an existing sriov-vf

    +

    update an existing site-pair-set

    application/json application/xml

    +
    +
    +

    site-pair-set object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /site-pair-set +
    +
    +
    @@ -105963,42 +123800,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -106009,12 +123814,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pci-id + site-pair-set-id -

    PCI ID used to identify the sriov-vf

    +

    Unique id of site pair set.

    		 path @@ -106072,11 +123938,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    Tags: Network
    @@ -106091,7 +123957,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)

    @@ -106116,58 +123982,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + site-pair-set-id -

    PCI ID used to identify the sriov-vf

    +

    Unique id of site pair set.

    		 path @@ -106209,11 +124027,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    Tags: Network
    @@ -106241,58 +124059,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + site-pair-set-id -

    PCI ID used to identify the sriov-vf

    +

    Unique id of site pair set.

    		 path @@ -106334,17 +124104,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    returns routing-instances
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

    Tags: Network
    -

    returns vlans

    +

    returns routing-instances

    @@ -106361,42 +124131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -106407,81 +124145,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -106508,7 +124171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /routing-instances
    @@ -106536,198 +124199,61 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlan
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Network + +
    +
    +

    returns routing-instance

    + +
    +
    +
    - 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 - - -
    + + + + + + + + + + - + - - - - - - - - + @@ -106756,7 +124282,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /routing-instance
    @@ -106784,17 +124310,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    create or update an existing routing-instance

    @@ -106803,13 +124329,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

    - /vlan + /routing-instance
    @@ -106828,42 +124354,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - -
    - network-name + site-pair-set-id -

    Name of the network

    +

    Unique id of site pair set.

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-key + routing-instance-id -

    This indicates the customers VPN ID associated with this vlan

    +

    Unique id of routing instance

    		querypath string +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -106876,10 +124370,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -106921,23 +124415,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    update an existing routing-instance

    application/json application/xml

    +
    +
    +

    routing-instance object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /routing-instance +
    +
    +
    @@ -106953,10 +124459,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -106969,10 +124475,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -106983,12 +124489,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -107001,10 +124568,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -107062,19 +124629,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -107089,10 +124673,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -107105,10 +124689,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -107119,12 +124703,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/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 +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -107137,10 +124782,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -107151,12 +124796,68 @@ 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 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

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -107343,7 +124910,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /site-pairs
    @@ -107371,36 +124938,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-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 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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns site-pair

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    - l3-interface-ipv4-address + site-pair-set-id -

    IP address

    +

    Unique id of site pair set.

    		 path @@ -107169,152 +124870,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - 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 + routing-instance-id -

    Neutron id of subnet that address belongs to

    +

    Unique id of routing instance

    		querypath string +
    @@ -107415,42 +124965,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -107463,10 +124981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -107479,10 +124997,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + site-pair-id -

    IP address

    +

    unique identifier of probe

    		 path @@ -107502,6 +125020,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /site-pair +
    +
    +
    + +
    default @@ -107524,23 +125065,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

    +

    +
    +
    +
    +
    + /site-pair +
    +
    +
    @@ -107556,42 +125109,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -107604,10 +125125,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -107620,10 +125141,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + site-pair-id -

    IP address

    +

    unique identifier of probe

    		 path @@ -107634,22 +125155,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -107681,17 +125186,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing site-pair

    @@ -107700,13 +125205,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

    +

    site-pair object that needs to be created or updated.

    - /relationship + /site-pair
    @@ -107725,42 +125230,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -107773,10 +125246,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -107789,10 +125262,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + site-pair-id -

    IP address

    +

    unique identifier of probe

    		 path @@ -107834,17 +125307,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing site-pair

    @@ -107866,26 +125339,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name that identifies the physical interface

    +

    Unique id of site pair set.

    		 path @@ -107898,10 +125355,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name given to the interface

    +

    Unique id of routing instance

    		 path @@ -107914,10 +125371,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + site-pair-id -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -107930,12 +125387,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -107975,17 +125432,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-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 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 l3-interface-ipv6-address-list

    +

    returns classes-of-service

    @@ -108002,42 +125459,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name given to the interface

    +

    Unique id of site pair set.

    		 path @@ -108050,10 +125475,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + routing-instance-id -

    String that identifies the interface

    +

    Unique id of routing instance

    		 path @@ -108066,10 +125491,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + site-pair-id -

    IP address

    +

    unique identifier of probe

    		 path @@ -108080,156 +125505,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-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 - - -
    @@ -108256,7 +125531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /classes-of-service
    @@ -108284,70 +125559,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns class-of-service

    -
    - -

    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 + site-pair-set-id -

    Name that identifies the physical interface

    +

    Unique id of site pair set.

    		 path @@ -108360,10 +125602,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name given to the interface

    +

    Unique id of routing instance

    		 path @@ -108376,10 +125618,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + site-pair-id -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -108392,10 +125634,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -108415,6 +125657,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /class-of-service +
    +
    +
    + +
    default @@ -108437,23 +125702,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

    +

    +
    +
    +
    +
    + /class-of-service +
    +
    +
    @@ -108469,26 +125746,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name that identifies the physical interface

    +

    Unique id of site pair set.

    		 path @@ -108501,10 +125762,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name given to the interface

    +

    Unique id of routing instance

    		 path @@ -108517,10 +125778,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + site-pair-id -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -108533,10 +125794,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -108547,22 +125808,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -108594,17 +125839,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing class-of-service

    @@ -108613,13 +125858,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

    +

    class-of-service object that needs to be created or updated.

    - /relationship + /class-of-service
    @@ -108638,26 +125883,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + site-pair-set-id -

    Name that identifies the physical interface

    +

    Unique id of site pair set.

    		 path @@ -108670,10 +125899,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name given to the interface

    +

    Unique id of routing instance

    		 path @@ -108686,10 +125915,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + site-pair-id -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -108702,10 +125931,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -108747,17 +125976,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing class-of-service

    @@ -108779,10 +126008,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -108795,10 +126024,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -108811,10 +126040,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -108827,10 +126056,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + cos -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -108843,12 +126072,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -108888,11 +126117,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    PUT /network/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
    @@ -108907,7 +126136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

    @@ -108932,10 +126161,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -108948,10 +126177,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -108964,10 +126193,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -108980,10 +126209,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + cos -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -109025,11 +126254,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    DELETE /network/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
    @@ -109057,10 +126286,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -109073,10 +126302,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -109089,10 +126318,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -109105,10 +126334,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + cos -

    String that identifies the interface

    +

    unique identifier of probe

    		 path @@ -109150,11 +126379,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/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
    @@ -109169,7 +126398,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

    @@ -109194,10 +126423,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -109210,10 +126439,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    +     		path + string + + + +
    + site-pair-id + +

    unique identifier of probe

    		 path @@ -109255,11 +126500,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/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
    @@ -109287,10 +126532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + site-pair-set-id -

    unique name of Physical Network Function.

    +

    Unique id of site pair set.

    		 path @@ -109303,10 +126548,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    +     		path + string + + + +
    + site-pair-id + +

    unique identifier of probe

    		 path @@ -109348,96 +126609,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-pfs
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

    +
    returns vces
    +

    GET /network/vces

    Tags: Network
    -

    returns sriov-pfs

    +

    returns vces

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -109461,7 +126645,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /sriov-pfs + /vces
    @@ -109489,17 +126673,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-pf
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

    +
    returns vce
    +

    GET /network/vces/vce/{vnf-id}

    Tags: Network
    -

    returns sriov-pf

    +

    returns vce

    @@ -109516,10 +126700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id -

    unique name of Physical Network Function.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -109532,42 +126716,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name that identifies the physical interface

    +

    Name of VNF.

    		pathquery string -
    - pf-pci-id + vnf-name2 -

    Identifier for the sriov-pf

    +

    Alternate name of VNF.

    		pathquery string -
    - inv-status + vnf-type -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -109592,6 +126804,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + vpe-id + +

    Unique ID of VPE connected to this VCE.

    +     		query + string + + +
    @@ -109618,7 +126860,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-pf + /vce
    @@ -109646,17 +126888,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    create or update an existing vce
    +

    PUT /network/vces/vce/{vnf-id}

    Tags: Network
    -

    create or update an existing sriov-pf

    +

    create or update an existing vce

    @@ -109665,13 +126907,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-pf object that needs to be created or updated

    +

    vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)

    - /sriov-pf + /vce
    @@ -109690,42 +126932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - pf-pci-id + vnf-id -

    Identifier for the sriov-pf

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -109767,23 +126977,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-pf
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

    +
    update an existing vce
    +

    PATCH /network/vces/vce/{vnf-id}

    Tags: Network
    -

    delete an existing sriov-pf

    +

    update an existing vce

    application/json application/xml

    +
    +
    +

    vce object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vce +
    +
    +
    @@ -109799,42 +127021,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - pf-pci-id + vnf-id -

    Identifier for the sriov-pf

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -109845,22 +127035,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -109892,35 +127066,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    +
    delete an existing vce
    +

    DELETE /network/vces/vce/{vnf-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vce

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -109936,26 +127098,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + - -
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -109968,12 +127114,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pf-pci-id + resource-version -

    Identifier for the sriov-pf

    +

    resource-version for concurrency

    		pathquery string @@ -110013,24 +127159,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    +
    returns entitlements
    +

    GET /network/vces/vce/{vnf-id}/entitlements

    Tags: Network
    -

    delete an existing relationship

    +

    returns entitlements

    -
    - -

    application/json application/xml -

    -
    @@ -110045,10 +127186,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
    - pnf-name + vnf-id -

    unique name of Physical Network Function.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -110061,247 +127202,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name that identifies the physical interface

    +

    Name of VNF.

    		pathquery string -
    - pf-pci-id + vnf-name2 -

    Identifier for the sriov-pf

    +

    Alternate name of VNF.

    		pathquery 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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - + - -
    - pnf-name + vnf-type -

    unique name of Physical Network Function.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery 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 + service-id -

    unique name of Physical Network Function.

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		pathquery + 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 -

    - -
    -
    - 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

    @@ -110324,7 +127346,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /route-table-references + /entitlements
    @@ -110352,17 +127374,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns route-table-reference
    -

    GET /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    returns entitlement
    +

    GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    returns route-table-reference

    +

    returns entitlement

    @@ -110379,26 +127401,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + 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 -

    Route Table Reference id, UUID assigned to this instance.

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - route-table-reference-fqdn + prov-status -

    FQDN entry in the route table.

    +

    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 @@ -110434,7 +127593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /route-table-reference + /entitlement
    @@ -110462,17 +127621,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing route-table-reference
    -

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    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 route-table-reference

    +

    create or update an existing entitlement

    @@ -110481,13 +127640,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    route-table-reference object that needs to be created or updated

    +

    entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)

    - /route-table-reference + /entitlement
    @@ -110506,10 +127665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + vnf-id -

    Route Table Reference id, UUID assigned to this instance.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -110520,73 +127679,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + group-uuid -

    Route Table Reference id, UUID assigned to this instance.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -110599,12 +127697,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + resource-uuid -

    resource-version for concurrency

    +

    Unique ID of an entitlement resource.

    		querypath string @@ -110644,17 +127742,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    +
    update an existing entitlement
    +

    PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing entitlement

    @@ -110663,13 +127761,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

    +

    entitlement object that needs to be created or updated.

    - /relationship + /entitlement
    @@ -110688,10 +127786,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + vnf-id -

    Route Table Reference id, UUID assigned to this instance.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -110702,73 +127800,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + group-uuid -

    Route Table Reference id, UUID assigned to this instance.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -110779,132 +127816,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + resource-uuid -

    Unique id of site pair set.

    +

    Unique ID of an entitlement resource.

    		 path @@ -110924,29 +127841,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /site-pair-set -
    -
    -
    - -
    default @@ -110969,35 +127863,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing site-pair-set
    -

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    +
    delete an existing entitlement
    +

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    create or update an existing site-pair-set

    +

    delete an existing entitlement

    application/json application/xml

    -
    -
    -

    site-pair-set object that needs to be created or updated

    -

    -
    -
    -
    -
    - /site-pair-set -
    -
    -
    @@ -111013,10 +127895,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -111027,73 +127909,28 @@ 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 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 + group-uuid -

    Unique id of site pair set.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +     		path + string + + + +
    + resource-uuid + +

    Unique ID of an entitlement resource.

    		 path @@ -111151,11 +127988,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    +

    PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -111170,7 +128007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)

    @@ -111195,10 +128032,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    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 @@ -111240,11 +128109,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    +

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -111272,10 +128141,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -111286,68 +128155,28 @@ 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 routing-instances
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

    - Tags: - Network -
    -
    -
    -

    returns routing-instances

    - -
    -
    - - - - - - - - - - - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -111495,7 +128405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /routing-instance + /licenses
    @@ -111523,36 +128433,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    returns license
    +

    GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    create or update an existing routing-instance

    +

    returns license

    -
    - -

    application/json application/xml -

    -
    -
    -

    routing-instance object that needs to be created or updated

    -

    -
    -
    -
    -
    - /routing-instance -
    -
    -
    -
    - site-pair-set-id + group-uuid -

    Unique id of site pair set.

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +     		path + string + + + +
    + resource-uuid + +

    Unique ID of an entitlement resource.

    		 path @@ -111367,29 +128196,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /routing-instances -
    -
    -
    - -
    default @@ -111412,17 +128218,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns routing-instance
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

    +
    returns licenses
    +

    GET /network/vces/vce/{vnf-id}/licenses

    Tags: Network
    -

    returns routing-instance

    +

    returns licenses

    @@ -111439,10 +128245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -111455,18 +128261,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + vnf-name -

    Unique id of routing instance

    +

    Name of VNF.

    		pathquery + 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 -
    @@ -111567,10 +128460,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -111583,10 +128476,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + group-uuid -

    Unique id of routing instance

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -111597,73 +128490,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + resource-uuid -

    Unique id of site pair set.

    +

    Unique ID of a license resource.

    		 path @@ -111676,26 +128508,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + vnf-name -

    Unique id of routing instance

    +

    Name of VNF.

    		pathquery string -
    - resource-version + vnf-name2 -

    resource-version for concurrency

    +

    Alternate name of VNF.

    		 query @@ -111703,123 +128534,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - site-pair-set-id + vnf-type -

    Unique id of site pair set.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - routing-instance-id + service-id -

    Unique id of routing instance

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		pathquery + 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 -

    - -
    +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /license +
    +
    +
    + +
    default @@ -111842,23 +128680,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    create or update an existing license
    +

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    delete an existing relationship

    +

    create or update an existing license

    application/json application/xml

    +
    +
    +

    license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)

    +

    +
    +
    +
    +
    + /license +
    +
    +
    @@ -111874,10 +128724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + - + - -
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -111890,10 +128740,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + group-uuid -

    Unique id of routing instance

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    +     		path + string + + + +
    + resource-uuid + +

    Unique ID of a license resource.

    		 path @@ -111935,19 +128801,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns site-pairs
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

    +
    update an existing license
    +

    PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    returns site-pairs

    +

    update an existing license

    +
    + +

    application/json application/xml +

    +
    +
    +

    license object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /license +
    +
    +
    +
    @@ -111962,10 +128845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - -
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -111978,10 +128861,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + group-uuid -

    Unique id of routing instance

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    +     		path + string + + + +
    + resource-uuid + +

    Unique ID of a license resource.

    		 path @@ -112001,29 +128900,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /site-pairs -
    -
    -
    - -
    default @@ -112046,19 +128922,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    delete an existing license
    +

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    returns site-pair

    +

    delete an existing license

    +
    + +

    application/json application/xml +

    +
    @@ -112073,10 +128954,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -112089,10 +128970,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + group-uuid -

    Unique id of routing instance

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -112105,10 +128986,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + resource-uuid -

    unique identifier of probe

    +

    Unique ID of a license resource.

    		 path @@ -112119,6 +129000,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -112128,29 +129025,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /site-pair -
    -
    -
    - -
    default @@ -112173,17 +129047,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    see node definition for valid relationships
    +

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing site-pair

    +

    see node definition for valid relationships

    @@ -112192,13 +129066,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    site-pair object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)

    - /site-pair + /relationship
    @@ -112217,10 +129091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -112233,10 +129107,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + group-uuid -

    Unique id of routing instance

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -112249,10 +129123,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + resource-uuid -

    unique identifier of probe

    +

    Unique ID of a license resource.

    		 path @@ -112294,17 +129168,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    delete an existing relationship
    +

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    -

    delete an existing site-pair

    +

    delete an existing relationship

    @@ -112326,10 +129200,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -112342,10 +129216,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + group-uuid -

    Unique id of routing instance

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -112358,10 +129232,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + resource-uuid -

    unique identifier of probe

    +

    Unique ID of a license resource.

    		 path @@ -112372,22 +129246,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -112419,17 +129277,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    returns port-groups
    +

    GET /network/vces/vce/{vnf-id}/port-groups

    Tags: Network
    -

    returns classes-of-service

    +

    returns port-groups

    @@ -112446,10 +129304,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -112462,177 +129320,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + vnf-name -

    Unique id of routing instance

    +

    Name of VNF.

    		pathquery string -
    - site-pair-id + vnf-name2 -

    unique identifier of probe

    +

    Alternate name of VNF.

    		pathquery 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

    - -
    -
    - - - - - - - - - - - - + - + - + - + + + + + + + + + + + + + + + @@ -112661,7 +129464,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /class-of-service + /port-groups
    @@ -112689,36 +129492,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    returns port-group
    +

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    create or update an existing class-of-service

    +

    returns port-group

    -
    - -

    application/json application/xml -

    -
    -
    -

    class-of-service object that needs to be created or updated

    -

    -
    -
    -
    -
    - /class-of-service -
    -
    -
    -
    - site-pair-set-id + vnf-type -

    Unique id of site pair set.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - routing-instance-id + service-id -

    Unique id of routing instance

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		pathquery string -
    - site-pair-id + regional-resource-zone -

    unique identifier of probe

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - cos + prov-status -

    unique identifier of probe

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery + 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 -
    @@ -112733,10 +129519,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -112749,10 +129535,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-id -

    Unique id of routing instance

    +

    Unique ID of the interface

    		 path @@ -112765,167 +129551,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + vnf-name -

    unique identifier of probe

    +

    Name of VNF.

    		pathquery string -
    - cos + vnf-name2 -

    unique identifier of probe

    +

    Alternate name of VNF.

    		pathquery 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -112945,6 +129723,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /port-group +
    +
    +
    + +
    default @@ -112967,17 +129768,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    create or update an existing port-group
    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing port-group

    @@ -112986,13 +129787,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

    +

    port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)

    - /relationship + /port-group
    @@ -113011,42 +129812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - site-pair-set-id + vnf-type -

    Unique id of site pair set.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - routing-instance-id + service-id -

    Unique id of routing instance

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		pathquery string -
    - site-pair-id + regional-resource-zone -

    unique identifier of probe

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - cos + prov-status -

    unique identifier of probe

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - resource-version + heat-stack-id -

    resource-version for concurrency

    +

    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 @@ -112933,7 +129712,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - 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 + vnf-id -

    unique identifier of probe

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -113059,10 +129828,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + interface-id -

    unique identifier of probe

    +

    Unique ID of the interface

    		 path @@ -113104,23 +129873,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    update an existing port-group
    +

    PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing port-group

    application/json application/xml

    +
    +
    +

    port-group object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /port-group +
    +
    +
    @@ -113136,42 +129917,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + + + + + + + + + + + + + +
    - 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 + vnf-id -

    unique identifier of probe

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -113184,10 +129933,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + interface-id -

    unique identifier of probe

    +

    Unique ID of the interface

    		 path @@ -113229,35 +129978,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    delete an existing port-group
    +

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing port-group

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -113273,10 +130010,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -113289,10 +130026,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-id -

    Unique id of routing instance

    +

    Unique ID of the interface

    		 path @@ -113305,12 +130042,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + resource-version -

    unique identifier of probe

    +

    resource-version for concurrency

    		pathquery string @@ -113350,24 +130087,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    returns cvlan-tags
    +

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

    Tags: Network
    -

    delete an existing relationship

    +

    returns cvlan-tags

    -
    - -

    application/json application/xml -

    -
    @@ -113382,10 +130114,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - site-pair-set-id + vnf-id -

    Unique id of site pair set.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -113398,10 +130130,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-id -

    Unique id of routing instance

    +

    Unique ID of the interface

    		 path @@ -113414,65 +130146,173 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + vnf-name -

    unique identifier of probe

    +

    Name of VNF.

    		pathquery + 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 -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns vces
    -

    GET /network/vces

    - Tags: - Network -
    -
    -
    -

    returns vces

    - -
    -

    application/json application/xml

    @@ -113495,7 +130335,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vces + /cvlan-tags
    @@ -113523,17 +130363,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vce
    -

    GET /network/vces/vce/{vnf-id}

    +
    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 vce

    +

    returns cvlan-tag-entry

    @@ -113550,10 +130390,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + vnf-id + +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of the interface

    		 path @@ -113564,6 +130420,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    vnf-name @@ -113684,6 +130556,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -113710,7 +130627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vce + /cvlan-tag-entry
    @@ -113738,17 +130655,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vce
    -

    PUT /network/vces/vce/{vnf-id}

    +
    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 vce

    +

    create or update an existing cvlan-tag-entry

    @@ -113757,13 +130674,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vce object that needs to be created or updated

    +

    cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

    - /vce + /cvlan-tag-entry
    @@ -113796,6 +130713,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-id + +

    Unique ID of the interface

    +     		path + string + + + +
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    @@ -113827,23 +130776,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vce
    -

    DELETE /network/vces/vce/{vnf-id}

    +
    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
    -

    delete an existing vce

    +

    update an existing cvlan-tag-entry

    application/json application/xml

    +
    +
    +

    cvlan-tag-entry object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /cvlan-tag-entry +
    +
    +
    @@ -113875,12 +130836,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - resource-version + interface-id -

    resource-version for concurrency

    +

    Unique ID of the interface

    		querypath string @@ -113889,6 +130850,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    @@ -113920,19 +130897,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns entitlements
    -

    GET /network/vces/vce/{vnf-id}/entitlements

    +
    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
    -

    returns entitlements

    +

    delete an existing cvlan-tag-entry

    +
    + +

    application/json application/xml +

    +
    @@ -113963,115 +130945,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -114090,29 +131000,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /entitlements -
    -
    -
    - -
    default @@ -114135,19 +131022,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlement
    -

    GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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
    -

    returns entitlement

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - 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 + interface-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique ID of the interface

    		querypath string +
    - heat-stack-id + cvlan-tag -

    Heat stack id corresponding to this instance, managed by MSO

    +

    See mis-na-virtualization-platform.yang

    		querypath - string + integer +
    - vpe-id + resource-version -

    Unique ID of VPE connected to this VCE.

    +

    resource-version for concurrency

    		 query @@ -114079,6 +130988,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -114178,10 +131082,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - group-uuid + interface-id -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Unique ID of the interface

    		 path @@ -114194,138 +131098,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + cvlan-tag -

    Unique ID of an entitlement resource.

    +

    See mis-na-virtualization-platform.yang

    		 path - string + 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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -114337,29 +131230,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /entitlement -
    -
    -
    - -
    default @@ -114382,17 +131252,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing entitlement
    -

    PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    see node definition for valid relationships
    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing entitlement

    +

    see node definition for valid relationships

    @@ -114401,13 +131271,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    entitlement object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)

    - /entitlement + /relationship
    @@ -114442,26 +131312,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not 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 + vnf-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - heat-stack-id + interface-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique ID of the interface

    		querypath string +
    - vpe-id + cvlan-tag -

    Unique ID of VPE connected to this VCE.

    +

    See mis-na-virtualization-platform.yang

    		querypath - string + integer +
    - group-uuid - -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    -     		path - string - - - -
    - resource-uuid + interface-id -

    Unique ID of an entitlement resource.

    +

    Unique ID of the interface

    		 path @@ -114503,17 +131357,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing entitlement
    -

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    delete an existing relationship
    +

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing entitlement

    +

    delete an existing relationship

    @@ -114551,26 +131405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid - -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    -     		path - string - - - -
    - resource-uuid + interface-id -

    Unique ID of an entitlement resource.

    +

    Unique ID of the interface

    		 path @@ -114581,22 +131419,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -114628,11 +131450,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +

    PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

    Tags: Network
    @@ -114647,7 +131469,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)

    @@ -114686,38 +131508,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - - -
    @@ -114749,11 +131539,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +

    DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

    Tags: Network
    @@ -114795,38 +131585,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - - -
    @@ -114858,17 +131616,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns licenses
    -

    GET /network/vces/vce/{vnf-id}/licenses

    +
    returns vnfcs
    +

    GET /network/vnfcs

    Tags: Network
    -

    returns licenses

    +

    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

    @@ -114885,10 +131707,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -114901,10 +131723,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + nfc-naming-code -

    Name of VNF.

    +

    Short code that is used in naming instances of the item being modeled

    		 query @@ -114916,10 +131738,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name2 + nfc-function -

    Alternate name of VNF.

    +

    English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

    		 query @@ -114931,10 +131753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + prov-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 of this vnfc

    		 query @@ -114946,10 +131768,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + ipaddress-v4-oam-vip -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    Oam V4 vip address of this vnfc

    		 query @@ -114961,10 +131783,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + in-maint -

    Regional way of organizing pservers, source of truth should define values

    +     		query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + group-notation + +

    Group notation of VNFC

    		 query @@ -114976,10 +131826,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + model-invariant-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    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 @@ -114989,27 +131854,290 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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/v11/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 +

    +
    +
    + + + + + + + + + + + - + @@ -115028,29 +132157,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /licenses -
    -
    -
    - -
    default @@ -115073,17 +132179,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns license
    -

    GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    returns l3-interface-ipv4-address-list
    +

    GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    returns license

    +

    returns l3-interface-ipv4-address-list

    @@ -115100,10 +132206,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
    - heat-stack-id + vnfc-name -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique ID of vnfc.

    		querypath string +
    - vpe-id + resource-version -

    Unique ID of VPE connected to this VCE.

    +

    resource-version for concurrency

    		 query @@ -115017,6 +132145,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -115116,10 +132222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + l3-interface-ipv4-address -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    IP address

    		 path @@ -115132,26 +132238,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + nfc-naming-code -

    Unique ID of a license resource.

    +

    Short code that is used in naming instances of the item being modeled

    		pathquery string -
    - vnf-name + nfc-function -

    Name of VNF.

    +

    English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

    		 query @@ -115163,10 +132268,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name2 + prov-status -

    Alternate name of VNF.

    +

    prov status of this vnfc

    		 query @@ -115178,10 +132283,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + ipaddress-v4-oam-vip -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Oam V4 vip address of this vnfc

    		 query @@ -115193,10 +132298,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + in-maint -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +     		query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + group-notation + +

    Group notation of VNFC

    		 query @@ -115208,10 +132341,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + model-invariant-id -

    Regional way of organizing pservers, source of truth should define values

    +

    the ASDC model id for this resource or service model.

    		 query @@ -115223,10 +132356,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + model-version-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    the ASDC model version for this resource or service model.

    		 query @@ -115238,10 +132371,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vlan-id-inner -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -115253,10 +132401,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpe-id + neutron-subnet-id -

    Unique ID of VPE connected to this VCE.

    +

    Neutron id of subnet that address belongs to

    		 query @@ -115292,7 +132440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /license + /l3-interface-ipv4-address-list
    @@ -115320,17 +132468,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing license
    -

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    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 license

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -115339,13 +132487,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    license object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

    - /license + /l3-interface-ipv4-address-list
    @@ -115364,26 +132512,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + vnfc-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Unique ID of vnfc.

    		 path @@ -115396,10 +132528,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv4-address -

    Unique ID of a license resource.

    +

    IP address

    		 path @@ -115441,23 +132573,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing license
    -

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    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
    -

    delete an existing license

    +

    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 +
    +
    +
    @@ -115473,26 +132617,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + vnfc-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Unique ID of vnfc.

    		 path @@ -115505,10 +132633,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv4-address -

    Unique ID of a license resource.

    +

    IP address

    		 path @@ -115519,22 +132647,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -115566,35 +132678,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -115610,10 +132710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -115626,10 +132726,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + l3-interface-ipv4-address -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    IP address

    		 path @@ -115642,12 +132742,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + resource-version -

    Unique ID of a license resource.

    +

    resource-version for concurrency

    		pathquery string @@ -115687,23 +132787,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -115719,26 +132831,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + +
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + vnfc-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Unique ID of vnfc.

    		 path @@ -115751,10 +132847,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + l3-interface-ipv4-address -

    Unique ID of a license resource.

    +

    IP address

    		 path @@ -115796,19 +132892,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns port-groups
    -

    GET /network/vces/vce/{vnf-id}/port-groups

    +
    delete an existing relationship
    +

    DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    returns port-groups

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -115823,10 +132924,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -115966,29 +132963,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /port-groups -
    -
    -
    - -
    default @@ -116011,17 +132985,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns port-group
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    returns l3-interface-ipv6-address-list
    +

    GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    returns port-group

    +

    returns l3-interface-ipv6-address-list

    @@ -116038,10 +133012,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -115839,122 +132940,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - 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 + l3-interface-ipv4-address -

    Unique ID of VPE connected to this VCE.

    +

    IP address

    		querypath string +
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -116054,10 +133028,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + l3-interface-ipv6-address -

    Unique ID of the interface

    +

    IP address

    		 path @@ -116070,10 +133044,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + nfc-naming-code -

    Name of VNF.

    +

    Short code that is used in naming instances of the item being modeled

    		 query @@ -116085,10 +133059,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name2 + nfc-function -

    Alternate name of VNF.

    +

    English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

    		 query @@ -116100,10 +133074,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + prov-status -

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 of this vnfc

    		 query @@ -116115,10 +133089,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + ipaddress-v4-oam-vip -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    Oam V4 vip address of this vnfc

    		 query @@ -116130,14 +133104,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + in-maint -

    Regional way of organizing pservers, source of truth should define values

    		 query - string + boolean @@ -116145,14 +133118,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + is-closed-loop-disabled -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query - string + boolean @@ -116160,10 +133132,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + group-notation -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Group notation of VNFC

    		 query @@ -116175,10 +133147,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpe-id + model-invariant-id -

    Unique ID of VPE connected to this VCE.

    +

    the ASDC model id for this resource or service model.

    		 query @@ -116190,10 +133162,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - port-group-id + model-version-id -

    Unique ID for port group in vmware

    +

    the ASDC model version for this resource or service model.

    		 query @@ -116205,10 +133177,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - switch-name + vlan-id-inner -

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -116220,10 +133207,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + neutron-subnet-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Neutron id of subnet that address belongs to

    		 query @@ -116259,7 +133246,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /port-group + /l3-interface-ipv6-address-list
    @@ -116287,17 +133274,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing port-group
    -

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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 port-group

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -116306,13 +133293,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    port-group object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

    - /port-group + /l3-interface-ipv6-address-list
    @@ -116331,10 +133318,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -116347,10 +133334,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + l3-interface-ipv6-address -

    Unique ID of the interface

    +

    IP address

    		 path @@ -116392,23 +133379,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing port-group
    -

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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
    -

    delete an existing port-group

    +

    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 +
    +
    +
    @@ -116424,10 +133423,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -116440,10 +133439,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + l3-interface-ipv6-address -

    Unique ID of the interface

    +

    IP address

    		 path @@ -116454,22 +133453,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -116501,19 +133484,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns cvlan-tags
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

    +
    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
    -

    returns cvlan-tags

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -116528,10 +133516,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - vnf-id + vnfc-name -

    Unique id of VNF. This is unique across the graph.

    +

    Unique ID of vnfc.

    		 path @@ -116544,10 +133532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + l3-interface-ipv6-address -

    Unique ID of the interface

    +

    IP address

    		 path @@ -116560,70 +133548,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    -     		query - string - - -
    - regional-resource-zone + resource-version -

    Regional way of organizing pservers, source of truth should define values

    +

    resource-version for concurrency

    		 query @@ -116631,102 +133559,418 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + +
    - prov-status + vnfc-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique ID of vnfc.

    		querypath string +
    - heat-stack-id + l3-interface-ipv6-address -

    Heat stack id corresponding to this instance, managed by MSO

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/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 +

    +
    +
    + + + + + + + + + + + - + - + + +
    - vpe-id + vnfc-name -

    Unique ID of VPE connected to this VCE.

    +

    Unique ID of vnfc.

    		querypath string +
    - port-group-id + l3-interface-ipv6-address -

    Unique ID for port group in vmware

    +

    IP address

    		querypath 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/v11/NetworkVnfcsVnfc.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - switch-name + vnfc-name -

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    +

    Unique ID of vnfc.

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - +
    - heat-stack-id + vnfc-name -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique ID of vnfc.

    		querypath 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

    @@ -116749,7 +133993,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cvlan-tags + /vpls-pes
    @@ -116777,17 +134021,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns cvlan-tag-entry
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

    +
    returns vpls-pe
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    returns cvlan-tag-entry

    +

    returns vpls-pe

    @@ -116804,26 +134048,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - interface-id + equipment-name -

    Unique ID of the interface

    		 path @@ -116834,178 +134061,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -117041,7 +134102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cvlan-tag-entry + /vpls-pe
    @@ -117069,17 +134130,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    create or update an existing vpls-pe
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    create or update an existing cvlan-tag-entry

    +

    create or update an existing vpls-pe

    @@ -117088,13 +134149,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cvlan-tag-entry object that needs to be created or updated

    +

    vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)

    - /cvlan-tag-entry + /vpls-pe
    @@ -117113,26 +134174,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - interface-id + equipment-name -

    Unique ID of the interface

    		 path @@ -117143,22 +134187,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag - -

    See mis-na-virtualization-platform.yang

    -     		path - integer - - - -
    @@ -117190,23 +134218,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    update an existing vpls-pe
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    delete an existing cvlan-tag-entry

    +

    update an existing vpls-pe

    application/json application/xml

    +
    +
    +

    vpls-pe object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vpls-pe +
    +
    +
    @@ -117222,10 +134262,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 @@ -117236,12 +134275,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing vpls-pe
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing vpls-pe

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - - - - -
    - interface-id + equipment-name -

    Unique ID of the interface

    		 path @@ -117252,22 +134351,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag - -

    See mis-na-virtualization-platform.yang

    -     		path - integer - - - -
    resource-version @@ -117315,36 +134398,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    returns lag-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns lag-interfaces

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -117359,10 +134425,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - @@ -117414,6 +134462,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interfaces +
    +
    +
    + +
    default @@ -117436,24 +134507,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    returns lag-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing relationship

    +

    returns lag-interface

    -
    - -

    application/json application/xml -

    -
    - vnf-id + equipment-name -

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117375,34 +134440,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + prov-status -

    Unique ID of the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string - -
    - cvlan-tag - -

    See mis-na-virtualization-platform.yang

    -     		path - integer - - -
    @@ -117468,10 +134534,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -117523,6 +134617,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interface +
    +
    +
    + +
    default @@ -117545,17 +134662,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    +
    create or update an existing lag-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing lag-interface

    @@ -117564,13 +134681,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

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

    - /relationship + /lag-interface
    @@ -117589,10 +134706,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 @@ -117484,10 +134549,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -117500,18 +134565,47 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + prov-status -

    See mis-na-virtualization-platform.yang

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery - integer + 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 -
    - vnf-id + equipment-name -

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117605,10 +134721,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -117650,23 +134766,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    +
    update an existing lag-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing lag-interface

    application/json application/xml

    +
    +
    +

    lag-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    @@ -117682,10 +134810,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -118049,7 +135210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + equipment-name -

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117698,10 +134825,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -117743,35 +134870,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

    +
    delete an existing lag-interface
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing lag-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -117787,10 +134902,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 @@ -117801,6 +134915,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -117832,24 +134978,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -117864,10 +135005,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 @@ -117878,51 +135018,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + 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 -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns vnfcs
    -

    GET /network/vnfcs

    - Tags: - Network -
    -
    -
    -

    returns vnfcs

    - -
    -

    application/json application/xml

    @@ -117945,7 +135105,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnfcs + /l-interfaces
    @@ -117973,17 +135133,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vnfc
    -

    GET /network/vnfcs/vnfc/{vnfc-name}

    +
    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 vnfc

    +

    returns l-interface

    @@ -118000,10 +135160,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    		 path @@ -118016,32 +135175,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nfc-naming-code + interface-name -

    Short code that is used in naming instances of the item being modeled

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - nfc-function + interface-name -

    English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

    +

    Name given to the interface

    		querypath string +
    -

    prov status of this vnfc

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -118061,10 +135222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipaddress-v4-oam-vip + interface-id -

    Oam V4 vip address of this vnfc

    +

    ID of interface

    		 query @@ -118076,27 +135237,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled + interface-role +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query - boolean + string @@ -118104,10 +135252,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-notation + interface-id -

    Group notation of VNFC

    +

    ID of interface

    		 query @@ -118119,10 +135267,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -118134,10 +135282,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -118173,7 +135321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnfc + /l-interface
    @@ -118201,17 +135349,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vnfc
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}

    +
    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 vnfc

    +

    create or update an existing l-interface

    @@ -118220,13 +135368,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vnfc object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

    - /vnfc + /l-interface
    @@ -118245,10 +135393,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -118290,23 +135469,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vnfc
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}

    +
    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
    -

    delete an existing vnfc

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -118322,10 +135513,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + +
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -118475,7 +135806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -119176,7 +136755,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 + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -118383,11 +135713,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv4-address-list
    -

    GET /network/vnfcs/vnfc/{vnfc-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
    @@ -118410,10 +135740,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    		 path @@ -118426,10 +135755,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 that identifies the link aggregate interface

    		 path @@ -118442,32 +135771,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nfc-naming-code + interface-name -

    Short code that is used in naming instances of the item being modeled

    +

    Name given to the interface

    		querypath string +
    - nfc-function + l3-interface-ipv4-address -

    English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

    +

    IP address

    		querypath string +
    -

    prov status of this vnfc

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -118487,10 +135818,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipaddress-v4-oam-vip + interface-id -

    Oam V4 vip address of this vnfc

    +

    ID of interface

    		 query @@ -118502,27 +135833,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled + interface-role +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query - boolean + string @@ -118530,10 +135848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-notation + interface-id -

    Group notation of VNFC

    +

    ID of interface

    		 query @@ -118545,10 +135863,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -118560,10 +135878,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -118644,7 +135962,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -118672,11 +135990,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/vnfcs/vnfc/{vnfc-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
    @@ -118691,7 +136009,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -118716,10 +136034,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -118777,11 +136126,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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/vnfcs/vnfc/{vnfc-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
    @@ -118809,10 +136294,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -118886,11 +136402,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vnfcs/vnfc/{vnfc-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
    @@ -118905,7 +136421,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -118930,10 +136446,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name + + path + string + + + +
    + interface-name -

    Unique ID of vnfc.

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -118991,11 +136538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vnfcs/vnfc/{vnfc-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
    @@ -119023,10 +136570,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -119084,11 +136662,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv6-address-list
    -

    GET /network/vnfcs/vnfc/{vnfc-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
    @@ -119111,10 +136689,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    		 path @@ -119127,10 +136704,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 that identifies the link aggregate interface

    		 path @@ -119143,32 +136720,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nfc-naming-code + interface-name -

    Short code that is used in naming instances of the item being modeled

    +

    Name given to the interface

    		querypath string +
    - nfc-function + l3-interface-ipv6-address -

    English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

    +

    IP address

    		querypath string +
    -

    prov status of this vnfc

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -119188,10 +136767,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipaddress-v4-oam-vip + interface-id -

    Oam V4 vip address of this vnfc

    +

    ID of interface

    		 query @@ -119203,27 +136782,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled + interface-role +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query - boolean + string @@ -119231,10 +136797,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-notation + interface-id -

    Group notation of VNFC

    +

    ID of interface

    		 query @@ -119246,10 +136812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -119261,10 +136827,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -119345,7 +136911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -119373,11 +136939,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/vnfcs/vnfc/{vnfc-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
    @@ -119392,7 +136958,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -119417,10 +136983,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -119478,23 +137075,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -119510,10 +137119,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    		 path @@ -119526,10 +137134,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 that identifies the link aggregate interface

    		 path @@ -119542,12 +137150,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -119587,35 +137211,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -119631,10 +137243,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    		 path @@ -119647,10 +137258,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 that identifies the link aggregate interface

    		 path @@ -119661,73 +137272,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name -

    Unique ID of vnfc.

    +

    Name given to the interface

    		 path @@ -119754,6 +137304,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -119785,11 +137351,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}/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
    @@ -119804,7 +137370,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -119829,10 +137395,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    +     		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 @@ -119874,11 +137487,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}/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
    @@ -119906,10 +137519,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + equipment-name -

    Unique ID of vnfc.

    		 path @@ -119920,131 +137532,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - - + + + + + + + + @@ -120079,29 +137589,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vpls-pe -
    -
    -
    - -
    default @@ -120124,17 +137611,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}

    +
    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
    -

    create or update an existing vpls-pe

    +

    see node definition for valid relationships

    @@ -120143,13 +137630,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

    - /vpls-pe + /relationship
    @@ -120181,6 +137668,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + +
    - equipment-name + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -120057,17 +137550,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name given to the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    @@ -120212,17 +137731,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 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 vpls-pe

    +

    delete an existing relationship

    @@ -120259,12 +137778,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path string @@ -120304,17 +137839,17 @@ 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

    +
    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 lag-interfaces

    +

    returns sriov-vfs

    @@ -120344,6 +137879,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    prov-status @@ -120359,6 +137926,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -120385,7 +138027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /sriov-vfs
    @@ -120413,17 +138055,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 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 lag-interface

    +

    returns sriov-vf

    @@ -120469,6 +138111,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    prov-status @@ -120514,6 +138188,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -120540,7 +138319,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /sriov-vf
    @@ -120568,17 +138347,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 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 lag-interface

    +

    create or update an existing sriov-vf

    @@ -120587,13 +138366,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

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /lag-interface + /sriov-vf
    @@ -120641,88 +138420,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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

    +

    Name given to the interface

    		 path @@ -120735,12 +138438,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -120780,19 +138483,36 @@ 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

    +
    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
    -

    returns l-interfaces

    +

    update an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    @@ -120838,47 +138558,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -120890,29 +138597,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -120935,19 +138619,24 @@ 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}

    +
    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
    -

    returns l-interface

    +

    delete an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - interface-role + pci-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    @@ -121009,85 +138698,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -121106,29 +138737,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interface -
    -
    -
    - -
    default @@ -121151,17 +138759,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}

    +
    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
    -

    create or update an existing l-interface

    +

    see node definition for valid relationships

    @@ -121170,13 +138778,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l-interface + /relationship
    @@ -121240,6 +138848,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + +
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + pci-id -

    MAC address for the interface

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - network-name + resource-version -

    Name of the network

    +

    resource-version for concurrency

    		 query @@ -121095,6 +138725,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 + + + +
    @@ -121271,17 +138895,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 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 l-interface

    +

    delete an existing relationship

    @@ -121350,12 +138974,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -121395,17 +139019,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 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 l3-interface-ipv4-address-list

    +

    returns vlans

    @@ -121467,22 +139091,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    prov-status @@ -121515,40 +139123,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + interface-role -

    MAC address for the interface

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -121560,10 +139138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-id -

    Name of the network

    +

    ID of interface

    		 query @@ -121575,25 +139153,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 + macaddr -

    Neutron network id of the interface that address belongs to

    +

    MAC address for the interface

    		 query @@ -121605,10 +139168,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + network-name -

    Neutron id of subnet that address belongs to

    +

    Name of the network

    		 query @@ -121644,7 +139207,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /vlans
    @@ -121672,36 +139235,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns 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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -121763,10 +139309,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 @@ -121777,6 +139323,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-key + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    @@ -121786,6 +139452,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    default @@ -121808,23 +139497,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing 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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    create or update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -121887,10 +139588,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 @@ -121901,22 +139602,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -121948,17 +139633,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing 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
    -

    see node definition for valid relationships

    +

    update an existing vlan

    @@ -121967,13 +139652,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

    +

    vlan object that needs to be created or updated.

    - /relationship + /vlan
    @@ -122039,10 +139724,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 @@ -122084,17 +139769,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing 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 relationship

    +

    delete an existing vlan

    @@ -122163,10 +139848,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 @@ -122177,6 +139862,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -122208,17 +139909,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 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-ipv6-address-list

    +

    returns l3-interface-ipv4-address-list

    @@ -122282,7 +139983,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -122401,6 +140118,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 @@ -122457,7 +140204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -122485,17 +140232,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 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-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -122504,13 +140251,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -122576,118 +140323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -122700,7 +140339,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -122714,22 +140353,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -122761,17 +140384,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv4-address-list

    @@ -122780,13 +140403,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv4-address-list
    @@ -122852,7 +140475,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -122897,17 +140536,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing l3-interface-ipv4-address-list

    @@ -122929,9 +140568,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + equipment-name + + path + string + + + +
    + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -122947,7 +140602,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 given to the interface

    		 path @@ -122960,10 +140615,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -122976,7 +140631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -122990,6 +140645,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -123021,11 +140692,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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
    @@ -123040,7 +140711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -123110,88 +140781,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -123204,10 +140799,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -123249,19 +140844,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    returns sriov-vfs

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -123323,92 +140923,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -123420,29 +140962,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -123465,17 +140984,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 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 sriov-vf

    +

    returns l3-interface-ipv6-address-list

    @@ -123539,10 +141058,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + +
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath string +
    - network-name + l3-interface-ipv4-address -

    Name of the network

    +

    IP address

    		querypath string +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -123645,14 +141180,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-filter + vlan-id-inner -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Inner VLAN tag

    		 query - string + integer @@ -123660,10 +141195,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + vpn-key -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -123675,14 +141210,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-strip + vlan-id-inner -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    +

    Inner VLAN tag

    		 query - boolean + integer @@ -123693,7 +141228,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen neutron-network-id -

    Neutron network id of the interface

    +

    Neutron network id of the interface that address belongs to

    +     		query + string + + +
    + neutron-subnet-id + +

    Neutron id of subnet that address belongs to

    		 query @@ -123729,7 +141279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -123757,17 +141307,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 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 sriov-vf

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -123776,13 +141326,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -123848,10 +141398,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -123893,23 +141459,35 @@ 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}

    +
    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
    -

    delete an existing sriov-vf

    +

    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 +
    +
    +
    @@ -123972,10 +141550,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -123988,12 +141566,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -124033,35 +141611,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -124124,10 +141690,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -124138,6 +141720,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -124169,23 +141767,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -124248,10 +141858,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -124293,19 +141919,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -124367,92 +141998,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -124464,29 +142037,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -124509,19 +142059,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    returns vlan

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - 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 + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath string +
    - network-name + l3-interface-ipv6-address -

    Name of the network

    +

    IP address

    		querypath string +
    @@ -124597,126 +142164,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-key - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -124726,29 +142173,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -124771,35 +142195,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    create or update an existing vlan

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    vlan object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vlan -
    -
    -
    @@ -124907,23 +142319,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -124968,54 +142392,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -125047,19 +142423,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -125103,210 +142484,83 @@ 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 p-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

    + Tags: + Network +
    +
    +
    +

    returns p-interfaces

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
    - 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 + equipment-name -

    Neutron network id of the interface that address belongs to

    		querypath string +
    - neutron-subnet-id + prov-status -

    Neutron id of subnet that address belongs to

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -125342,7 +142596,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /p-interfaces
    @@ -125370,36 +142624,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns p-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns p-interface

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -125432,23 +142669,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - + @@ -125500,6 +142719,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /p-interface +
    +
    +
    + +
    default @@ -125522,23 +142764,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing p-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    create or update an existing p-interface

    application/json application/xml

    +
    +
    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    +

    Name that identifies the physical interface

    		 path @@ -125461,34 +142682,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv4-address + prov-status -

    IP address

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    @@ -125572,55 +142826,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    +

    Name that identifies the physical interface

    		 path @@ -125631,22 +142837,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -125678,17 +142868,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing p-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing p-interface

    @@ -125697,13 +142887,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

    +

    p-interface object that needs to be created or updated.

    - /relationship + /p-interface
    @@ -125740,7 +142930,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 @@ -125751,12 +142941,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - + - - - - - - - - - - - - - -
    - interface-name + equipment-name -

    Name given to the interface

    		 path @@ -125769,10 +143019,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 that identifies the physical interface

    		 path @@ -125785,12 +143035,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -125830,24 +143080,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -125880,23 +143125,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - + @@ -125948,6 +143175,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interfaces +
    +
    +
    + +
    default @@ -125970,17 +143220,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    returns l-interface

    @@ -126015,7 +143265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    +

    Name that identifies the physical interface

    		 path @@ -125909,34 +143138,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv4-address + prov-status -

    IP address

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    -

    Name that identifies the link aggregate interface

    +

    Name that identifies the physical interface

    		 path @@ -126042,38 +143292,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    prov-status @@ -126091,25 +143309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -126164,81 +143367,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -126265,7 +143393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l-interface
    @@ -126293,17 +143421,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    create or update an existing l-interface

    @@ -126312,13 +143440,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

    - /l3-interface-ipv6-address-list + /l-interface
    @@ -126355,7 +143483,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 @@ -126382,38 +143510,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -126445,23 +143541,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 l-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -126495,7 +143603,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 @@ -126522,54 +143630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -126601,35 +143661,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -126663,7 +143711,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 @@ -126692,28 +143740,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -126753,24 +143785,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -126803,7 +143830,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 @@ -126832,23 +143859,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -126862,264 +143873,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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 + prov-status +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - interface-name + prov-status -

    Name that identifies the link aggregate interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - interface-name + interface-id -

    Name given to the interface

    +

    ID of interface

    		pathquery string -
    - vlan-interface + macaddr -

    String that identifies the interface

    +

    MAC address for the interface

    		pathquery 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + @@ -127131,110 +144002,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - default +
    + 200 OK
    -
    +
    -

    Response codes found in response codes.

    +

    successful operation

    - +
    -
    - -
    -
    - - - - - -
    -
    -
    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 + network-name +

    Name of the network

    		pathquery string -
    - interface-name + vlan-id-inner -

    Name that identifies the link aggregate interface

    +

    Inner VLAN tag

    		pathquery - string + integer -
    - interface-name + neutron-network-id -

    Name given to the interface

    +

    Neutron network id of the interface that address belongs to

    		pathquery string -
    - vlan-interface + neutron-subnet-id -

    String that identifies the interface

    +

    Neutron id of subnet that address belongs to

    		pathquery string -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    - equipment-name - - path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    -
    +
    -
    -

    application/json application/xml -

    - -
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -127257,23 +144047,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    create or update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -127307,7 +144109,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 @@ -127318,67 +144120,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns p-interfaces
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

    - Tags: - Network -
    -
    -
    -

    returns p-interfaces

    - -
    -
    - - - - - - - - - - - - + @@ -127413,29 +144161,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interfaces -
    -
    -
    - -
    default @@ -127458,19 +144183,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interface
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    returns p-interface

    +

    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 + interface-name +

    Name given to the interface

    		 path @@ -127391,17 +144138,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    IP address

    		querypath string +
    @@ -127516,32 +144258,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -127553,29 +144297,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interface -
    -
    -
    - -
    default @@ -127598,35 +144319,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing p-interface
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    create or update an existing p-interface

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    p-interface object that needs to be created or updated

    -

    -
    -
    -
    -
    - /p-interface -
    -
    -
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name given to the interface

    		querypath string +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    IP address

    		querypath string +
    @@ -127671,6 +144380,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -127702,23 +144459,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing p-interface
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    delete an existing p-interface

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -127765,12 +144534,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + +
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string @@ -127810,19 +144595,24 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    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
    -

    returns l-interfaces

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -127868,32 +144658,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -127905,29 +144697,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -127950,17 +144719,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    returns l3-interface-ipv6-address-list

    @@ -128022,6 +144791,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name given to the interface

    		querypath string +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    IP address

    		querypath string +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    prov-status @@ -128097,6 +144882,51 @@ 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 + +

    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 + + +
    @@ -128123,7 +144953,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l3-interface-ipv6-address-list
    @@ -128151,17 +144981,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -128170,13 +145000,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /l-interface + /l3-interface-ipv6-address-list
    @@ -128240,6 +145070,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -128271,23 +145117,35 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    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 +
    +
    +
    @@ -128350,12 +145208,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -128395,19 +145253,24 @@ 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}/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-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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -128469,7 +145332,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -128612,29 +145371,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -128657,17 +145393,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -128676,13 +145412,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /relationship
    @@ -128748,7 +145484,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -128485,115 +145348,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 - - -
    - 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 + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -128601,6 +145359,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -128793,17 +145529,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    delete an existing relationship

    @@ -128872,7 +145608,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -128886,22 +145622,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -128933,11 +145653,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -128952,7 +145672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -129022,12 +145742,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 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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - l3-interface-ipv4-address + equipment-name -

    IP address

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -129069,24 +145881,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns sriov-vfs

    -
    - -

    application/json application/xml -

    -
    @@ -129148,18 +145955,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -129171,6 +146037,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vfs +
    +
    +
    + +
    default @@ -129193,17 +146082,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    returns sriov-vf

    @@ -129267,10 +146156,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + +
    - l3-interface-ipv4-address + prov-status -

    IP address

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery + 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 -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -129358,14 +146247,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + vf-vlan-filter -

    Inner VLAN tag

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query - integer + string @@ -129373,10 +146262,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + vf-mac-filter -

    Neutron network id of the interface that address belongs to

    +

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    		 query @@ -129388,10 +146277,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + vf-vlan-strip -

    Neutron id of subnet that address belongs to

    +

    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 @@ -129427,7 +146331,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /sriov-vf
    @@ -129455,17 +146359,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}/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 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 l3-interface-ipv6-address-list

    +

    create or update an existing sriov-vf

    @@ -129474,13 +146378,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

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l3-interface-ipv6-address-list + /sriov-vf
    @@ -129546,10 +146450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -129591,23 +146495,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -129670,10 +146586,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -129684,22 +146600,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -129731,35 +146631,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/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 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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -129822,118 +146710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - 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 + pci-id -

    Name given to the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -129946,12 +146726,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -129991,11 +146771,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -130010,7 +146790,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -130080,6 +146860,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    @@ -130111,11 +146907,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    @@ -130188,6 +146984,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    @@ -130219,17 +147031,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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 sriov-vfs

    +

    returns vlans

    @@ -130392,7 +147204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /vlans
    @@ -130420,17 +147232,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    returns vlan

    @@ -130494,10 +147306,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -130585,14 +147397,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-filter + vlan-id-inner -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Inner VLAN tag

    		 query - string + integer @@ -130600,10 +147412,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + vpn-key -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -130613,34 +147425,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    create or update an existing vlan
    +

    PUT /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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -130652,29 +147593,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vf -
    -
    -
    - -
    default @@ -130697,17 +147615,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    create or update an existing sriov-vf

    +

    update an existing vlan

    @@ -130716,13 +147634,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    vlan object that needs to be created or updated.

    - /sriov-vf + /vlan
    @@ -130788,10 +147706,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-strip + equipment-name -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    		querypath - boolean + string +
    - neutron-network-id + interface-name -

    Neutron network id of the interface

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -130833,17 +147751,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    delete an existing vlan

    @@ -130912,10 +147830,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -130973,36 +147891,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -131064,10 +147965,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -131078,6 +147995,156 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-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 + + +
    @@ -131087,6 +148154,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -131109,23 +148199,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /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 relationship

    +

    create or update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -131188,10 +148290,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -131233,19 +148351,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    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 +
    +
    +
    +
    @@ -131307,77 +148442,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -131389,29 +148481,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -131434,19 +148503,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    returns vlan

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath string +
    - network-name + l3-interface-ipv4-address -

    Name of the network

    +

    IP address

    		querypath string +
    @@ -131524,25 +148598,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    IP address

    		querypath string +
    - prov-status + resource-version -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    resource-version for concurrency

    		 query @@ -131550,81 +148625,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + - + @@ -131636,29 +148789,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -131681,35 +148811,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    create or update an existing vlan

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    vlan object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vlan -
    -
    -
    - interface-id + equipment-name -

    ID of interface

    		querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name that identifies the physical interface

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name given to the interface

    		querypath string +
    - vlan-id-inner + vlan-interface -

    Inner VLAN tag

    +

    String that identifies the interface

    		querypath - integer + string +
    - vpn-key + l3-interface-ipv4-address -

    This indicates the customers VPN ID associated with this vlan

    +

    IP address

    		querypath string +
    @@ -131786,6 +148904,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -131817,24 +148951,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -131912,12 +149041,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -131926,151 +149055,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/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 + prov-status +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - interface-name + prov-status -

    Name that identifies the physical interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - interface-name + interface-id -

    Name given to the interface

    +

    ID of interface

    		pathquery string -
    - vlan-interface + macaddr -

    String that identifies the interface

    +

    MAC address for the interface

    		pathquery string -
    - l3-interface-ipv4-address + network-name -

    IP address

    +

    Name of the network

    		pathquery string -
    - prov-status + vlan-id-inner -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Inner VLAN tag

    		 query - string + integer @@ -132078,10 +149147,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vpn-key -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -132093,14 +149162,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + vlan-id-inner -

    ID of interface

    +

    Inner VLAN tag

    		 query - string + integer @@ -132108,10 +149177,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + neutron-network-id -

    MAC address for the interface

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -132123,10 +149192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + neutron-subnet-id -

    Name of the network

    +

    Neutron id of subnet that address belongs to

    		 query @@ -132136,79 +149205,179 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + - + @@ -132220,29 +149389,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -132265,17 +149411,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}/p-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-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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    update an existing l3-interface-ipv6-address-list

    @@ -132284,13 +149430,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -132372,7 +149518,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - vlan-id-inner + equipment-name -

    Inner VLAN tag

    		querypath - integer + string +
    - vpn-key + interface-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name that identifies the physical interface

    		querypath string +
    - vlan-id-inner + interface-name -

    Inner VLAN tag

    +

    Name given to the interface

    		querypath - integer + string +
    - neutron-network-id + vlan-interface -

    Neutron network id of the interface that address belongs to

    +

    String that identifies the interface

    		querypath string +
    - neutron-subnet-id + l3-interface-ipv6-address -

    Neutron id of subnet that address belongs to

    +

    IP address

    		querypath string +
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -132417,17 +149563,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}/p-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-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-ipv4-address-list

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -132512,7 +149658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -132573,11 +149719,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/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
    @@ -132592,7 +149738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -132680,7 +149826,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -132725,11 +149871,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-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 /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
    @@ -132820,7 +149966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -132865,19 +150011,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -132953,12 +150116,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - + - + - + + +
    - l3-interface-ipv6-address + equipment-name -

    IP address

    		 path @@ -132971,152 +150194,246 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - prov-status + interface-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Name that identifies the physical interface

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - macaddr + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath 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/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - - - - - - - - + + +
    - network-name + equipment-name -

    Name of the network

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-key + interface-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name that identifies the physical 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}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - + - + @@ -133128,29 +150445,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv6-address-list -
    -
    -
    - -
    default @@ -133173,36 +150467,19 @@ 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}/p-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 sriov-pfs
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns sriov-pfs

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id + equipment-name -

    Neutron network id of the interface that address belongs to

    		querypath string +
    - neutron-subnet-id + interface-name -

    Neutron id of subnet that address belongs to

    +

    Name that identifies the physical interface

    		querypath string +
    @@ -133248,50 +150525,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -133303,6 +150562,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-pfs +
    +
    +
    + +
    default @@ -133325,24 +150607,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    returns sriov-pf

    -
    - -

    application/json application/xml -

    -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv6-address + prov-status -

    IP address

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    @@ -133388,26 +150665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -133459,6 +150718,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-pf +
    +
    +
    + +
    default @@ -133481,17 +150763,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing sriov-pf

    @@ -133500,13 +150782,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

    +

    sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

    - /relationship + /sriov-pf
    @@ -133556,10 +150838,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + pf-pci-id -

    String that identifies the interface

    +

    Identifier for the sriov-pf

    		 path @@ -133420,26 +150681,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + prov-status -

    IP address

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - resource-version + prov-status -

    resource-version for concurrency

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -133447,7 +150707,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - interface-name + pf-pci-id -

    Name given to the interface

    +

    Identifier for the sriov-pf

    		 path @@ -133570,12 +150852,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface + equipment-name -

    String that identifies the interface

    		 path @@ -133588,10 +150942,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + interface-name -

    IP address

    +

    Name that identifies the physical interface

    +     		path + string + + + +
    + pf-pci-id + +

    Identifier for the sriov-pf

    		 path @@ -133633,17 +151003,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing sriov-pf

    @@ -133696,26 +151066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + pf-pci-id -

    String that identifies the interface

    +

    Identifier for the sriov-pf

    		 path @@ -133728,12 +151082,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -133773,11 +151127,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    Tags: Network
    @@ -133792,7 +151146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

    @@ -133848,26 +151202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + pf-pci-id -

    String that identifies the interface

    +

    Identifier for the sriov-pf

    		 path @@ -133909,11 +151247,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    Tags: Network
    @@ -133972,26 +151310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + pf-pci-id -

    String that identifies the interface

    +

    Identifier for the sriov-pf

    		 path @@ -134033,11 +151355,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    Tags: Network
    @@ -134052,7 +151374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)

    @@ -134090,22 +151412,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    @@ -134137,11 +151443,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    Tags: Network
    @@ -134182,22 +151488,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    @@ -134229,95 +151519,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-pfs
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

    +
    returns vpn-bindings
    +

    GET /network/vpn-bindings

    Tags: Network
    -

    returns sriov-pfs

    +

    returns vpn-bindings

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -134341,7 +151555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /sriov-pfs + /vpn-bindings
    @@ -134369,17 +151583,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-pf
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

    +
    returns vpn-binding
    +

    GET /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: Network
    -

    returns sriov-pf

    +

    returns vpn-binding

    @@ -134396,41 +151610,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 physical interface

    -     		path - string - - - -
    - pf-pci-id + vpn-id -

    Identifier for the sriov-pf

    +

    VPN ID, globally unique within A&AI

    		 path @@ -134443,10 +151626,10 @@ 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 @@ -134458,10 +151641,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vpn-type -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Type of the vpn, should be taken from enumerated/valid values

    		 query @@ -134497,7 +151680,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-pf + /vpn-binding
    @@ -134525,17 +151708,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    create or update an existing vpn-binding
    +

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: Network
    -

    create or update an existing sriov-pf

    +

    create or update an existing vpn-binding

    @@ -134544,13 +151727,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-pf object that needs to be created or updated

    +

    vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)

    - /sriov-pf + /vpn-binding
    @@ -134569,41 +151752,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 physical interface

    -     		path - string - - - -
    - pf-pci-id + vpn-id -

    Identifier for the sriov-pf

    +

    VPN ID, globally unique within A&AI

    		 path @@ -134645,23 +151797,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    update an existing vpn-binding
    +

    PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: Network
    -

    delete an existing sriov-pf

    +

    update an existing vpn-binding

    application/json application/xml

    +
    +
    +

    vpn-binding object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vpn-binding +
    +
    +
    @@ -134677,41 +151841,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 physical interface

    -     		path - string - - - -
    - pf-pci-id + vpn-id -

    Identifier for the sriov-pf

    +

    VPN ID, globally unique within A&AI

    		 path @@ -134722,22 +151855,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -134769,35 +151886,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    +
    delete an existing vpn-binding
    +

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vpn-binding

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -134813,25 +151918,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - equipment-name - - path - string - - - -
    - interface-name + vpn-id -

    Name that identifies the physical interface

    +

    VPN ID, globally unique within A&AI

    		 path @@ -134844,12 +151934,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pf-pci-id + resource-version -

    Identifier for the sriov-pf

    +

    resource-version for concurrency

    		pathquery string @@ -134889,23 +151979,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -134921,41 +152023,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 physical interface

    -     		path - string - - - -
    - pf-pci-id + vpn-id -

    Identifier for the sriov-pf

    +

    VPN ID, globally unique within A&AI

    		 path @@ -134997,35 +152068,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -135041,9 +152100,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 @@ -135085,24 +152145,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    +
    returns route-targets
    +

    GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

    Tags: Network
    -

    delete an existing relationship

    +

    returns route-targets

    -
    - -

    application/json application/xml -

    -
    @@ -135117,9 +152172,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 @@ -135130,6 +152186,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vpn-name + +

    VPN Name

    +     		query + string + + +
    + vpn-type + +

    Type of the vpn, should be taken from enumerated/valid values

    +     		query + string + + +
    @@ -135139,6 +152225,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /route-targets +
    +
    +
    + +
    default @@ -135161,19 +152270,112 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vpn-bindings
    -

    GET /network/vpn-bindings

    +
    returns route-target
    +

    GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

    Tags: Network
    -

    returns vpn-bindings

    +

    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 @@ -135197,7 +152399,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /vpn-bindings + /route-target
    @@ -135225,19 +152427,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vpn-binding
    -

    GET /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    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
    -

    returns vpn-binding

    +

    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/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

    +

    +
    +
    +
    +
    + /route-target +
    +
    +
    +
    @@ -135268,32 +152487,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -135305,29 +152526,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vpn-binding -
    -
    -
    - -
    default @@ -135350,17 +152548,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vpn-binding
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    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
    -

    create or update an existing vpn-binding

    +

    update an existing route-target

    @@ -135369,13 +152567,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vpn-binding object that needs to be created or updated

    +

    route-target object that needs to be created or updated.

    - /vpn-binding + /route-target
    @@ -135408,6 +152606,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + +
    - vpn-name + global-route-target -

    VPN Name

    +

    Number used to identify an RT, globally unique in the network

    		querypath string +
    - vpn-type + route-target-role -

    Type of the vpn, should be taken from enumerated/valid values

    +

    Role assigned to this route target

    		querypath 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 + + + +
    @@ -135439,17 +152669,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vpn-binding
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    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 vpn-binding

    +

    delete an existing route-target

    @@ -135485,6 +152715,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 @@ -135532,11 +152794,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    +

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

    Tags: Network
    @@ -135551,7 +152813,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

    @@ -135590,73 +152852,28 @@ 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 -

    -
    -
    - - - - - - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + +
    - vpn-id + global-route-target -

    VPN ID, globally unique within A&AI

    +

    Number used to identify an RT, globally unique in the network

    +     		path + string + + + +
    + route-target-role + +

    Role assigned to this route target

    		 path @@ -135698,19 +152915,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns route-targets
    -

    GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

    +
    delete an existing relationship
    +

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

    Tags: Network
    -

    returns route-targets

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -135741,38 +152963,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - +
    - vpn-name + global-route-target -

    VPN Name

    +

    Number used to identify an RT, globally unique in the network

    		querypath string +
    - vpn-type + route-target-role -

    Type of the vpn, should be taken from enumerated/valid values

    +

    Role assigned to this route target

    		querypath 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

    @@ -135795,7 +153060,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /route-targets + /zones
    @@ -135823,17 +153088,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns route-target
    -

    GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

    +
    returns zone
    +

    GET /network/zones/zone/{zone-id}

    Tags: Network
    -

    returns route-target

    +

    returns zone

    @@ -135850,42 +153115,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + zone-id -

    Role assigned to this route target

    +

    Code assigned by AIC to the zone

    		 path @@ -135898,10 +153131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-name + design-type -

    VPN Name

    +

    Design of zone [Medium/Large?]

    		 query @@ -135913,10 +153146,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-type + zone-context -

    Type of the vpn, should be taken from enumerated/valid values

    +

    Context of zone [production/test]

    		 query @@ -135952,7 +153185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /route-target + /zone
    @@ -135980,17 +153213,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    create or update an existing zone
    +

    PUT /network/zones/zone/{zone-id}

    Tags: Network
    -

    create or update an existing route-target

    +

    create or update an existing zone

    @@ -135999,13 +153232,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    route-target object that needs to be created or updated

    +

    zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)

    - /route-target + /zone
    @@ -136024,42 +153257,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + zone-id -

    Role assigned to this route target

    +

    Code assigned by AIC to the zone

    		 path @@ -136101,23 +153302,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing route-target
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

    +
    update an existing zone
    +

    PATCH /network/zones/zone/{zone-id}

    Tags: Network
    -

    delete an existing route-target

    +

    update an existing zone

    application/json application/xml

    +
    +
    +

    zone object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /zone +
    +
    +
    @@ -136133,26 +153346,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - vpn-id - -

    VPN ID, globally unique within A&AI

    -     		path - string - - - -
    - global-route-target + zone-id -

    Number used to identify an RT, globally unique in the network

    +

    Code assigned by AIC to the zone

    		 path @@ -136163,12 +153360,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing zone
    +

    DELETE /network/zones/zone/{zone-id}

    + Tags: + Network +
    +
    +
    +

    delete an existing zone

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - route-target-role + zone-id -

    Role assigned to this route target

    +

    Code assigned by AIC to the zone

    		 path @@ -136226,11 +153484,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

    +

    PUT /network/zones/zone/{zone-id}/relationship-list/relationship

    Tags: Network
    @@ -136245,7 +153503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)

    @@ -136270,42 +153528,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + zone-id -

    Role assigned to this route target

    +

    Code assigned by AIC to the zone

    		 path @@ -136347,11 +153573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

    +

    DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

    Tags: Network
    @@ -136379,42 +153605,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + zone-id -

    Role assigned to this route target

    +

    Code assigned by AIC to the zone

    		 path @@ -136456,17 +153650,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns zones
    -

    GET /network/zones

    +
    returns models
    +

    GET /service-design-and-creation/models

    Tags: - Network + ServiceDesignAndCreation
    -

    returns zones

    +

    returns models

    @@ -136492,7 +153686,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /zones + /models
    @@ -136520,17 +153714,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns zone
    -

    GET /network/zones/zone/{zone-id}

    +
    returns model
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}

    Tags: - Network + ServiceDesignAndCreation
    -

    returns zone

    +

    returns model

    @@ -136547,10 +153741,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - zone-id + model-invariant-id -

    Code assigned by AIC to the zone

    +

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -136563,25 +153757,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - design-type - -

    Design of zone [Medium/Large?]

    -     		query - string - - -
    - zone-context + model-type -

    Context of zone [production/test]

    +

    Type of the model, e.g., service, resource, widget, etc.

    		 query @@ -136617,7 +153796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /zone + /model
    @@ -136645,17 +153824,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing zone
    -

    PUT /network/zones/zone/{zone-id}

    +
    create or update an existing model
    +

    PUT /service-design-and-creation/models/model/{model-invariant-id}

    Tags: - Network + ServiceDesignAndCreation
    -

    create or update an existing zone

    +

    create or update an existing model

    @@ -136664,13 +153843,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    zone object that needs to be created or updated

    +

    model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)

    - /zone + /model
    @@ -136689,10 +153868,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - zone-id + model-invariant-id -

    Code assigned by AIC to the zone

    +

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -136734,23 +153913,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing zone
    -

    DELETE /network/zones/zone/{zone-id}

    +
    update an existing model
    +

    PATCH /service-design-and-creation/models/model/{model-invariant-id}

    Tags: - Network + ServiceDesignAndCreation
    -

    delete an existing zone

    +

    update an existing model

    application/json application/xml

    +
    +
    +

    model object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /model +
    +
    +
    @@ -136766,10 +153957,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - zone-id + model-invariant-id -

    Code assigned by AIC to the zone

    +

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -136780,22 +153971,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -136827,35 +154002,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/zones/zone/{zone-id}/relationship-list/relationship

    +
    delete an existing model
    +

    DELETE /service-design-and-creation/models/model/{model-invariant-id}

    Tags: - Network + ServiceDesignAndCreation
    -

    see node definition for valid relationships

    +

    delete an existing model

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -136871,10 +154034,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - zone-id + model-invariant-id -

    Code assigned by AIC to the zone

    +

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -136885,6 +154048,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -136916,24 +154095,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

    +
    returns model-vers
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

    Tags: - Network + ServiceDesignAndCreation
    -

    delete an existing relationship

    +

    returns model-vers

    -
    - -

    application/json application/xml -

    -
    @@ -136948,10 +154122,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - zone-id + model-invariant-id -

    Code assigned by AIC to the zone

    +

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -136962,6 +154136,21 @@ 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 + + +
    @@ -136971,6 +154160,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /model-vers +
    +
    +
    + +
    default @@ -136993,19 +154205,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns models
    -

    GET /service-design-and-creation/models

    +
    returns model-ver
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

    Tags: ServiceDesignAndCreation
    -

    returns models

    +

    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 + + +
    +

    application/json application/xml @@ -137029,7 +154333,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /models + /model-ver
    @@ -137057,19 +154361,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns model
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}

    +
    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
    -

    returns model

    +

    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/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

    +

    +
    +
    +
    +
    + /model-ver +
    +
    +
    +
    @@ -137100,17 +154421,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -137122,29 +154444,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model -
    -
    -
    - -
    default @@ -137167,17 +154466,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing model
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}

    +
    update an existing model-ver
    +

    PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

    Tags: ServiceDesignAndCreation
    -

    create or update an existing model

    +

    update an existing model-ver

    @@ -137186,13 +154485,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model object that needs to be created or updated

    +

    model-ver object that needs to be created or updated.

    - /model + /model-ver
    @@ -137225,6 +154524,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + +
    - model-type + model-version-id -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		querypath string +
    + model-version-id + +

    Unique identifier corresponding to one version of a model in ASDC

    +     		path + string + + + +
    @@ -137256,17 +154571,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing model
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}

    +
    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

    +

    delete an existing model-ver

    @@ -137302,6 +154617,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + model-version-id + +

    Unique identifier corresponding to one version of a model in ASDC

    +     		path + string + + + +
    resource-version @@ -137349,17 +154680,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-vers
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

    +
    returns metadata
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

    Tags: ServiceDesignAndCreation
    -

    returns model-vers

    +

    returns metadata

    @@ -137390,6 +154721,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + model-version-id + +

    Unique identifier corresponding to one version of a model in ASDC

    +     		path + string + + + +
    model-type @@ -137405,6 +154752,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + model-name + +

    Name of the model, which can change from version to version.

    +     		query + string + + +
    + model-version + +

    Version

    +     		query + string + + +
    @@ -137431,7 +154808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-vers + /metadata
    @@ -137459,17 +154836,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns model-ver
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

    +
    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 model-ver

    +

    returns metadatum

    @@ -137516,6 +154893,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + metaname + + path + string + + + +
    model-type @@ -137587,7 +154979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-ver + /metadatum
    @@ -137615,35 +155007,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    +
    +
    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/v11/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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    -
    create or update an existing model-ver
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

    +
    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
    -

    create or update an existing model-ver

    +

    delete an existing metadatum

    application/json application/xml

    -
    -
    -

    model-ver object that needs to be created or updated

    -

    -
    -
    -
    -
    - /model-ver -
    -
    -
    @@ -137689,89 +155309,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 -

    -
    -
    - - - - - - - - - - - - - - - - - - @@ -138128,7 +155670,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /model-element
    @@ -138156,17 +155698,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 metadatum

    +

    create or update an existing model-element

    @@ -138175,13 +155717,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

    - /metadatum + /model-element
    @@ -138232,7 +155774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -138276,23 +155818,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing metadatum
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

    +
    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
    -

    delete an existing metadatum

    +

    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 + metaname -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -137829,17 +155371,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadata
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

    +
    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 metadata

    +

    returns model-elements

    @@ -137957,7 +155499,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /model-elements
    @@ -137985,17 +155527,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns metadatum
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

    +
    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 metadatum

    +

    returns model-element

    @@ -138044,7 +155586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + model-element-uuid
    - metaname + model-element-uuid
    @@ -138340,7 +155894,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - metaname + 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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -138400,17 +156062,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-elements
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

    +
    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-elements

    +

    returns model-constraints

    @@ -138457,6 +156119,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + - -
    + 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
    + model-element-uuid + + path + string + + + +
    model-type @@ -138528,7 +156205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-elements + /model-constraints
    @@ -138556,17 +156233,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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-element

    +

    returns model-constraint

    @@ -138628,6 +156305,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + model-constraint-uuid + + path + string + + + +
    model-type @@ -138699,7 +156391,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-element + /model-constraint
    @@ -138727,17 +156419,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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-element

    +

    create or update an existing model-constraint

    @@ -138746,13 +156438,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model-element object that needs to be created or updated

    +

    model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)

    - /model-element + /model-constraint
    @@ -138816,102 +156508,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 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 -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - @@ -138924,22 +156523,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - 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 + model-constraint-uuid
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -138971,19 +156554,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    returns model-constraints

    +

    update an existing model-constraint

    +
    + +

    application/json application/xml +

    +
    +
    +

    model-constraint object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /model-constraint +
    +
    +
    +
    @@ -139045,47 +156645,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -139097,29 +156667,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-constraints -
    -
    -
    - -
    default @@ -139143,18 +156690,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    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}

    +
    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
    -

    returns model-constraint

    +

    delete an existing model-constraint

    +
    + +

    application/json application/xml +

    +
    - model-type - -

    Type of the model, e.g., service, resource, widget, etc.

    -     		query - string - - -
    - model-name - -

    Name of the model, which can change from version to version.

    -     		query - string - - -
    - model-version + model-constraint-uuid -

    Version

    		querypath string +
    @@ -139231,40 +156783,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -139283,29 +156806,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-constraint -
    -
    -
    - -
    default @@ -139328,36 +156828,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing model-constraint
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

    +
    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
    -

    create or update an existing model-constraint

    +

    returns constrained-element-sets

    -
    - -

    application/json application/xml -

    -
    -
    -

    model-constraint object that needs to be created or updated

    -

    -
    -
    -
    -
    - /model-constraint -
    -
    -
    -
    - 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 + resource-version -

    Version

    +

    resource-version for concurrency

    		 query @@ -139272,6 +156794,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -139432,135 +156915,42 @@ 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 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 -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -139580,6 +156969,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /constrained-element-sets +
    +
    +
    + +
    default @@ -139602,17 +157014,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns constrained-element-sets
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

    +
    returns constrained-element-set
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns constrained-element-sets

    +

    returns constrained-element-set

    @@ -139689,6 +157101,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + @@ -81,6 +89,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -111,6 +124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -141,6 +159,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -171,6 +194,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -201,6 +229,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -221,6 +254,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -251,6 +289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -291,6 +334,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -321,6 +369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -351,6 +404,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -371,6 +429,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -386,6 +449,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -411,6 +479,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -451,6 +524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -481,6 +559,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -496,6 +579,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -521,6 +609,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -571,6 +664,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -601,6 +699,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -631,6 +734,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -651,6 +759,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -691,6 +804,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -721,6 +839,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -741,6 +864,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -761,6 +889,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -776,6 +909,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -801,6 +939,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -841,6 +984,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -871,6 +1019,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -886,6 +1039,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -911,6 +1069,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -961,6 +1124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -981,6 +1149,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -996,6 +1169,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1021,6 +1199,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1061,6 +1244,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1091,6 +1279,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1106,6 +1299,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1131,6 +1329,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1191,6 +1394,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1235,6 +1443,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1255,6 +1468,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1285,6 +1503,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1315,6 +1538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1345,6 +1573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1365,6 +1598,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1409,6 +1647,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1429,6 +1672,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1449,6 +1697,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1469,6 +1722,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1489,6 +1747,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1509,6 +1772,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1569,6 +1837,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1589,6 +1862,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1609,6 +1887,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1629,6 +1912,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1679,6 +1967,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1709,6 +2002,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1739,6 +2037,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1783,6 +2086,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1803,6 +2111,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1818,6 +2131,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1843,6 +2161,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1883,6 +2206,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1913,6 +2241,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1928,6 +2261,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1953,6 +2291,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1993,6 +2336,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2013,6 +2361,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2028,6 +2381,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2053,6 +2411,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2093,6 +2456,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2123,6 +2491,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2138,6 +2511,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2163,6 +2541,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2223,6 +2606,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2253,6 +2641,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2283,6 +2676,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2313,6 +2711,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2333,6 +2736,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2373,6 +2781,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2403,6 +2816,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2433,6 +2851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2463,6 +2886,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2493,6 +2921,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2523,6 +2956,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2553,6 +2991,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2573,6 +3016,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2588,6 +3036,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2613,6 +3066,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2653,6 +3111,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2683,6 +3146,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2698,6 +3166,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2723,6 +3196,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2773,6 +3251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2803,6 +3286,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2823,6 +3311,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2843,6 +3336,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2858,6 +3356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2883,6 +3386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2923,6 +3431,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2953,6 +3466,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2968,6 +3486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2993,6 +3516,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3043,6 +3571,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3063,6 +3596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3078,6 +3616,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3103,6 +3646,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3143,6 +3691,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3173,6 +3726,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3188,6 +3746,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3213,6 +3776,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3273,6 +3841,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3303,6 +3876,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3333,6 +3911,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3363,6 +3946,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3383,6 +3971,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3423,6 +4016,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3443,6 +4041,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3463,6 +4066,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3513,6 +4121,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3543,6 +4156,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3563,6 +4181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3583,6 +4206,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3598,6 +4226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3623,6 +4256,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3663,6 +4301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3693,6 +4336,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3708,6 +4356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3733,6 +4386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3783,6 +4441,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3803,6 +4466,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3818,6 +4486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3843,6 +4516,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3883,6 +4561,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3913,6 +4596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3928,6 +4616,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3953,6 +4646,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4013,6 +4711,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4075,7 +4778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /connectors + /connectors
    @@ -4230,7 +4933,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /connector + /connector
    @@ -4277,7 +4980,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    connector object that needs to be created or updated

    +

    connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)

    @@ -4347,6 +5050,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing connector
    +

    PATCH /business/connectors/connector/{resource-instance-id}

    + Tags: + Business +
    +
    +
    +

    update an existing connector

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    connector object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /connector +
    +
    +
    +
    +
    +
    - 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 + model-type +

    Type of the model, e.g., service, resource, widget, etc.

    		pathquery string -
    - model-constraint-uuid + model-name +

    Name of the model, which can change from version to version.

    		pathquery string -
    - resource-version + model-version -

    resource-version for concurrency

    +

    Version

    		 query @@ -139568,7 +156958,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    + constrained-element-set-uuid + + path + string + + + +
    model-type @@ -139760,7 +157187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /constrained-element-sets + /constrained-element-set
    @@ -139789,18 +157216,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns constrained-element-set
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    +
    create or update an existing constrained-element-set
    +

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns constrained-element-set

    +

    create or update an existing constrained-element-set

    +
    + +

    application/json application/xml +

    +
    +
    +

    constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

    +

    +
    +
    +
    +
    + /constrained-element-set +
    +
    +
    +
    @@ -139890,49 +157334,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + @@ -139944,29 +157493,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /constrained-element-set -
    -
    -
    - -
    default @@ -139990,34 +157516,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing constrained-element-set
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    +
    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
    -

    create or update an existing constrained-element-set

    +

    delete an existing constrained-element-set

    application/json application/xml

    -
    -
    -

    constrained-element-set object that needs to be created or updated

    -

    -
    -
    -
    -
    - /constrained-element-set -
    -
    -
    - model-type + model-invariant-id -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Unique identifier corresponding to the main definition of a model in ASDC

    		querypath string +
    - model-name + model-version-id -

    Name of the model, which can change from version to version.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		querypath string +
    - model-version + model-element-uuid -

    Version

    		querypath + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid + + path string +
    @@ -140108,6 +157622,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -140139,24 +157669,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing constrained-element-set
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    +
    returns element-choice-sets
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

    Tags: ServiceDesignAndCreation
    -

    delete an existing constrained-element-set

    +

    returns element-choice-sets

    -
    - -

    application/json application/xml -

    -
    @@ -140248,10 +157773,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -140271,6 +157825,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /element-choice-sets +
    +
    +
    + +
    default @@ -140293,17 +157870,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns element-choice-sets
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

    +
    returns element-choice-set
    +

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns element-choice-sets

    +

    returns element-choice-set

    @@ -140395,6 +157972,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + +
    - resource-version + model-type -

    resource-version for concurrency

    +

    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 @@ -140259,7 +157814,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    + element-choice-set-uuid + + path + string + + + +
    model-type @@ -140466,7 +158058,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /element-choice-sets + /element-choice-set
    @@ -140495,18 +158087,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    returns element-choice-set
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

    +
    create or update an existing element-choice-set
    +

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns element-choice-set

    +

    create or update an existing element-choice-set

    +
    + +

    application/json application/xml +

    +
    +
    +

    element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

    +

    +
    +
    +
    +
    + /element-choice-set +
    +
    +
    +
    @@ -140611,51 +158220,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - model-type - -

    Type of the model, e.g., service, resource, widget, etc.

    -     		query - string - - -
    - model-name - -

    Name of the model, which can change from version to version.

    -     		query - string - - -
    - model-version - -

    Version

    -     		query - string - - -
    @@ -140665,29 +158229,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /element-choice-set -
    -
    -
    - -
    default @@ -140711,16 +158252,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing element-choice-set
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

    +
    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
    -

    create or update an existing element-choice-set

    +

    update an existing element-choice-set

    @@ -140729,13 +158270,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    element-choice-set object that needs to be created or updated

    +

    element-choice-set object that needs to be created or updated.

    - /element-choice-set + /element-choice-set
    @@ -141063,7 +158604,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

    @@ -141381,7 +158922,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

    @@ -141669,7 +159210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

    @@ -141897,7 +159438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

    @@ -142095,7 +159636,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)

    @@ -142278,7 +159819,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /named-queries + /named-queries
    @@ -142386,7 +159927,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /named-query + /named-query
    @@ -142433,7 +159974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    named-query object that needs to be created or updated

    +

    named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

    @@ -142502,6 +160043,94 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -142549,10 +160178,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + 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

    + +
    +
    + + + + + + + + + + + + + + + + + + + + @@ -142572,6 +160286,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /named-query-elements +
    +
    +
    + +
    default @@ -142594,17 +160331,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns named-query-elements
    -

    GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

    +
    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-elements

    +

    returns named-query-element

    @@ -142634,6 +160371,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + - - - - - - - + + + + + + + + +
    + named-query-uuid + + path + string + + + +
    + named-query-name -

    resource-version for concurrency

    		 query @@ -142560,7 +160275,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    + named-query-element-uuid + + path + string + + + +
    named-query-name @@ -142674,7 +160426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /named-query-elements + /named-query-element
    @@ -142703,18 +160455,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    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}

    +
    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
    -

    returns named-query-element

    +

    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/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

    +

    +
    +
    +
    +
    + /named-query-element +
    +
    +
    +
    @@ -142757,20 +160526,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - named-query-name - - query - string - - -
    @@ -142780,29 +160535,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /named-query-element -
    -
    -
    - -
    default @@ -142826,16 +160558,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    create or update an existing named-query-element

    +

    update an existing named-query-element

    @@ -142844,13 +160576,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    named-query-element object that needs to be created or updated

    +

    named-query-element object that needs to be created or updated.

    - /named-query-element + /named-query-element
    @@ -143130,7 +160862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /property-constraints + /property-constraints
    @@ -143228,20 +160960,161 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-name - - query - 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/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)

    +

    +
    +
    +
    +
    + /property-constraint +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + named-query-uuid + + path + string + + + +
    + named-query-element-uuid + + path + string + + + +
    + property-constraint-uuid + + path + string + + + +
    @@ -143251,29 +161124,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /property-constraint -
    -
    -
    - -
    default @@ -143297,16 +161147,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    create or update an existing property-constraint

    +

    update an existing property-constraint

    @@ -143315,13 +161165,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    property-constraint object that needs to be created or updated

    +

    property-constraint object that needs to be created or updated.

    - /property-constraint + /property-constraint
    @@ -143631,7 +161481,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /related-lookups + /related-lookups
    @@ -143769,7 +161619,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /related-lookup + /related-lookup
    @@ -143816,7 +161666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    related-lookup object that needs to be created or updated

    +

    related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)

    @@ -143915,6 +161765,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -144056,7 +162024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)

    @@ -144280,7 +162248,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

    @@ -144474,7 +162442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

    @@ -144655,7 +162623,118 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-capabilities + /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
    @@ -144684,18 +162763,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    returns service-capability
    -

    GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    create or update an existing service-capability
    +

    PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    Tags: ServiceDesignAndCreation
    -

    returns service-capability

    +

    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/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

    +

    +
    +
    +
    +
    + /service-capability +
    +
    +
    +
    @@ -144749,29 +162845,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /service-capability -
    -
    -
    - -
    default @@ -144795,16 +162868,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing service-capability
    -

    PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    update an existing service-capability
    +

    PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    Tags: ServiceDesignAndCreation
    -

    create or update an existing service-capability

    +

    update an existing service-capability

    @@ -144813,13 +162886,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-capability object that needs to be created or updated

    +

    service-capability object that needs to be created or updated.

    - /service-capability + /service-capability
    @@ -145027,7 +163100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

    @@ -145242,7 +163315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /services + /services
    @@ -145352,7 +163425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service + /service
    @@ -145399,7 +163472,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service object that needs to be created or updated

    +

    service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)

    @@ -145469,6 +163542,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -145581,7 +163743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)

    @@ -145651,24 +163813,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

    +
    returns vnf-image
    +

    GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    Tags: ServiceDesignAndCreation
    -

    delete an existing relationship

    +

    returns vnf-image

    -
    - -

    application/json application/xml -

    -
    @@ -145683,10 +163981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    - service-id + vnf-image-uuid -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique ID of this asset

    		 path @@ -145697,51 +163995,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + application + +

    The application that the image instantiates.

    +     		query + string + + +
    + application-vendor + +

    The vendor of the application.

    +     		query + string + + +
    + application-version + +

    The version of the application.

    +     		query + string + + +
    -
    -

    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

    @@ -145764,7 +164066,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnf-images + /vnf-image
    @@ -145793,18 +164095,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    returns vnf-image
    -

    GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    create or update an existing vnf-image
    +

    PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns vnf-image

    +

    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/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)

    +

    +
    +
    +
    +
    + /vnf-image +
    +
    +
    +
    @@ -145833,51 +164152,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - application - -

    The application that the image instantiates.

    -     		query - string - - -
    - application-vendor - -

    The vendor of the application.

    -     		query - string - - -
    - application-version - -

    The version of the application.

    -     		query - string - - -
    @@ -145887,29 +164161,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vnf-image -
    -
    -
    - -
    default @@ -145933,16 +164184,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing vnf-image
    -

    PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    update an existing vnf-image
    +

    PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    Tags: ServiceDesignAndCreation
    -

    create or update an existing vnf-image

    +

    update an existing vnf-image

    @@ -145951,13 +164202,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vnf-image object that needs to be created or updated

    +

    vnf-image object that needs to be created or updated.

    - /vnf-image + /vnf-image
    @@ -146133,7 +164384,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)

    @@ -146283,6 +164534,45 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Schema definitions

    +
    +
    +

    aai-internal: + object + + + +

    +
    +
    + +
    +
    +
    + property-name: + string + + +
    +
    +
    + +
    +
    +
    + property-value: + string + + +
    +
    +
    + +
    +
    +
    +
    +
    +

    action: @@ -146445,19 +164735,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Represents a slice or partial piece of a resource that gets separately allotted

      -
    • TO generic-vnf (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO network-policy (One2One)
      • -
    • TO vlan (Many2Many)
      • -
    • TO l-interface (One2Many)
      • -
    • TO tunnel-xconnect (comprises allotted-resource, One2One)
      • -
    • TO vpn-binding (Many2Many)
      • -
    • TO allotted-resource (One2One)
      • -
    • FROM configuration
      • -
    • FROM service-instance (is composed of allotted-resource)
      • -
    • FROM service-instance
      • -
    • FROM allotted-resource
    +
  • 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)
    • +
  • 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
    • @@ -146695,14 +164986,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Availability zone, a collection of compute hosts/pservers

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of availability-zone)
      • -
    • FROM ctag-pool
      • -
    • FROM dvs-switch
      • -
    • FROM generic-vnf
      • -
    • FROM pserver
      • -
    • FROM vce
    +
  • 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
    • @@ -147034,7 +165326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM site-pair (is composed of class-of-service)
    +
  • TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
    • @@ -147289,23 +165581,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    cloud-region designates an installation of a cloud cluster or region or instantiation.

      -
    • TO esr-system-info (comprises cloud-region, One2Many)
      • -
    • TO complex (Many2One)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO tenant (comprises cloud-region, One2Many)
      • -
    • TO image (comprises cloud-region, One2Many)
      • -
    • TO flavor (comprises cloud-region, One2Many)
      • -
    • TO availability-zone (comprises cloud-region, One2Many)
      • -
    • TO oam-network (comprises cloud-region, One2Many)
      • -
    • TO dvs-switch (comprises cloud-region, One2Many)
      • -
    • TO volume-group (comprises cloud-region, One2Many)
      • -
    • TO group-assignment (comprises cloud-region, One2Many)
      • -
    • TO snapshot (comprises cloud-region, One2Many)
      • -
    • TO zone (Many2One)
      • -
    • TO vip-ipv4-address-list (comprises cloud-region, One2Many)
      • -
    • TO vip-ipv6-address-list (comprises cloud-region, One2Many)
      • -
    • FROM pserver
      • -
    • FROM logical-link
    +
  • 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
    • @@ -147772,18 +166067,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical locations that can house cloud-regions.

      -
    • TO ctag-pool (comprises complex, Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • FROM availability-zone
      • -
    • FROM cloud-region
      • -
    • FROM oam-network
      • -
    • FROM pserver
      • -
    • FROM pnf
      • -
    • FROM vce
      • -
    • FROM vpls-pe
      • -
    • FROM volume-group
      • -
    • FROM zone
      • -
    • FROM generic-vnf
    +
  • 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
    • @@ -148088,37 +166385,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Port Mirror Configuration.

      -
    • TO logical-link (One2Many)
      • -
    • TO metadatum (comprises configuration, One2Many)
      • -
    • TO allotted-resource (One2One)
      • -
    • FROM service-instance
      • -
    • FROM generic-vnf
    +
  • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • +
  • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • CONFIGURATION is DELETED when these are DELETED METADATUM
    • +
  • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
    • -
    - management-option: +
    + configuration-id: string +
    -

    Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

    +

    UUID assigned to configuration.

    -
    - configuration-id: +
    + management-option: string -
    -

    UUID assigned to configuration.

    +

    Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

    @@ -148251,7 +166550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object + object[]
    @@ -148260,7 +166559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship-list + relationship @@ -148271,7 +166570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    metadata: - object + object[]
    @@ -148280,7 +166579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metadata + metadatum @@ -148348,9 +166647,10 @@ 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
    +
  • 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
    • @@ -148540,9 +166840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO element-choice-set (comprises constrained-element-set, One2Many)
      • -
    • FROM model-element (is composed of constrained-element-set)
      • -
    • FROM model-constraint (is composed of constrained-element-set)
    +
  • 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
    • @@ -148689,8 +166990,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM l3-network (is composed of ctag-assignment)
      • -
    • FROM service-instance
    +
  • 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)
    • @@ -148796,10 +167097,10 @@ 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
      • -
    • FROM generic-vnf
    +
  • 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)
    • @@ -148943,7 +167244,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    customer identifiers to provide linkage back to BSS information.

      -
    • TO service-subscription (comprises customer, Many2Many)
    +
  • FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
    • +
  • CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
    • @@ -149198,8 +167500,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.

      -
    • TO availability-zone (Many2Many)
      • -
    • FROM cloud-region (is composed of dvs-switch)
    +
  • 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)
    • @@ -149567,8 +167869,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO model-element (comprises element-choice-set, One2Many)
      • -
    • FROM constrained-element-set (is composed of element-choice-set)
    +
  • 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
    • @@ -149715,8 +168018,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for entitlement group.

      -
    • FROM generic-vnf (is composed of entitlement)
      • -
    • FROM vce (is composed of entitlement)
    +
  • TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • @@ -149839,7 +168142,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist EMS address information used by EMS driver.

      -
    • TO esr-system-info (comprises esr-ems, One2Many)
    +
  • 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
    • @@ -149872,7 +168176,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-system-info-list: - object[] + object
    @@ -149881,7 +168185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info + esr-system-info-list @@ -149892,7 +168196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -149901,7 +168205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -149965,10 +168269,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist common address information of external systems.

      -
    • FROM esr-ems (is composed of esr-system-info)
      • -
    • FROM esr-vnfm (is composed of esr-system-info)
      • -
    • FROM esr-thirdparty-sdnc (is composed of esr-system-info)
      • -
    • FROM cloud-region (is composed of esr-system-info)
    +
  • 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)
    • @@ -150297,8 +168601,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist SDNC address information used by ONAP SDNC.

      -
    • TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
      • -
    • TO pnf (One2Many)
    +
  • 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
    • @@ -150355,7 +168660,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-system-info-list: - object[] + object
    @@ -150364,7 +168669,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info + esr-system-info-list @@ -150375,7 +168680,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -150384,7 +168689,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -150448,7 +168753,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist VNFM address information used by VF-C.

      -
    • TO esr-system-info (comprises esr-vnfm, One2One)
    +
  • 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
    • @@ -150505,7 +168811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-system-info-list: - object[] + object
    @@ -150514,7 +168820,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info + esr-system-info-list @@ -150525,7 +168831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -150534,7 +168840,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -150584,6 +168890,268 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -150603,7 +169171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-ems-list: - object[] + object
    @@ -150612,7 +169180,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-ems + esr-ems-list @@ -150623,7 +169191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-vnfm-list: - object[] + object
    @@ -150632,7 +169200,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-vnfm + esr-vnfm-list @@ -150643,7 +169211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-thirdparty-sdnc-list: - object[] + object
    @@ -150652,7 +169220,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-thirdparty-sdnc + esr-thirdparty-sdnc-list @@ -150759,8 +169327,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack flavor.

      -
    • FROM cloud-region (is composed of flavor)
      • -
    • FROM vserver
    +
  • 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
    • @@ -150966,6 +169535,438 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -150980,33 +169981,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General purpose VNF

      -
    • TO license-key-resource (Many2Many)
      • -
    • TO l-interface (comprises generic-vnf, Many2Many)
      • -
    • TO availability-zone (Many2Many)
      • -
    • TO lag-interface (comprises generic-vnf, Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO pserver (Many2Many)
      • -
    • TO vnf-image (Many2One)
      • -
    • TO vserver (One2Many)
      • -
    • TO service-instance (Many2Many)
      • -
    • TO site-pair-set (Many2Many)
      • -
    • TO network-profile (Many2Many)
      • -
    • TO pnf (Many2Many)
      • -
    • TO ipsec-configuration (Many2One)
      • -
    • TO configuration (One2Many)
      • -
    • TO vf-module (comprises generic-vnf, One2Many)
      • -
    • TO volume-group (One2Many)
      • -
    • TO vnfc (One2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO entitlement (comprises generic-vnf, One2Many)
      • -
    • TO license (comprises generic-vnf, One2Many)
      • -
    • TO complex (Many2Many)
      • -
    • TO ctag-pool (Many2Many)
      • -
    • FROM line-of-business
      • -
    • FROM platform
      • -
    • FROM virtual-data-center
      • -
    • FROM logical-link
      • -
    • FROM allotted-resource
    +
  • 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)
    • +
  • 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

    • @@ -151025,6 +170028,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + vnf-instance-id: + string + + + +
    +
    +

    vnf instance id.

    +
    + +
    +
    vnf-name: string @@ -151147,6 +170163,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + vnf-package-name: + string + + + +
    +
    +
    + +
    +
    +
    + vnf-discriptor-name: + string + + + +
    +
    +

    vnf discriptor name

    +
    + +
    +
    +
    + job-id: + string + + + +
    +
    +

    job id corresponding to vnf

    +
    + +
    +
    heat-stack-id: string @@ -151303,6 +170357,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + 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 @@ -151794,9 +170884,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack group-assignment used to store exclusivity groups (EG).

      -
    • TO tenant (Many2Many)
      • -
    • TO pserver (One2Many)
      • -
    • FROM cloud-region (is composed of group-assignment)
    +
  • 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)
    • @@ -151943,7 +171033,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM subnet (is composed of host-route)
    +
  • TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
    • @@ -152087,9 +171177,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack image.

      -
    • TO metadatum (comprises image, Many2Many)
      • -
    • FROM cloud-region (is composed of image)
      • -
    • FROM vserver
    +
  • 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
    • @@ -152409,18 +171501,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General mechanism for grouping instances

      -
    • TO model (Many2Many)
      • -
    • FROM l-interface
      • -
    • FROM vnfc
      • -
    • FROM l3-interface-ipv4-address-list
      • -
    • FROM l3-interface-ipv6-address-list
      • -
    • FROM l3-network
      • -
    • FROM pnf
      • -
    • FROM allotted-resource
      • -
    • FROM generic-vnf
      • -
    • FROM service-instance
      • -
    • FROM vip-ipv4-address-list
      • -
    • FROM vip-ipv6-address-list
    +
  • 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)
    • @@ -152777,7 +171869,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + aai-internal @@ -153035,8 +172127,9 @@ 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
    +
  • 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
    • @@ -153441,20 +172534,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical interfaces, e.g., a vnic.

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
      • -
    • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
      • -
    • TO l-interface (comprises l-interface, One2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • TO vlan (comprises l-interface, Many2Many)
      • -
    • TO sriov-vf (comprises l-interface, One2One)
      • -
    • FROM generic-vnf (is composed of l-interface)
      • -
    • FROM lag-interface (is composed of l-interface)
      • -
    • FROM newvce (is composed of l-interface)
      • -
    • FROM p-interface (is composed of l-interface)
      • -
    • FROM vserver (is composed of l-interface)
      • -
    • FROM allotted-resource
      • -
    • FROM l-interface (is composed of l-interface)
    +
  • 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 sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
    • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -153820,12 +172915,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
      • -
    • FROM l-interface (is composed of l3-interface-ipv4-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv4-address-list)
    +
  • 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)
    • @@ -153966,12 +173061,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
      • -
    • FROM l-interface (is composed of l3-interface-ipv6-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv6-address-list)
    +
  • 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)
    • @@ -154112,22 +173207,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Generic network definition

      -
    • TO vpn-binding (Many2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO subnet (comprises l3-network, Many2Many)
      • -
    • TO service-instance (Many2Many)
      • -
    • TO ctag-assignment (comprises l3-network, Many2Many)
      • -
    • TO network-policy (Many2Many)
      • -
    • TO segmentation-assignment (comprises l3-network, One2Many)
      • -
    • TO route-table-reference (Many2Many)
      • -
    • FROM cloud-region
      • -
    • FROM complex
      • -
    • FROM generic-vnf
      • -
    • FROM l3-interface-ipv4-address-list
      • -
    • FROM l3-interface-ipv6-address-list
      • -
    • FROM tenant
      • -
    • FROM vf-module
      • -
    • FROM allotted-resource
    +
  • 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)
    • +
  • 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
    • @@ -154582,14 +173678,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Link aggregate interface

      -
    • TO logical-link (Many2Many)
      • -
    • TO lag-link (Many2Many)
      • -
    • TO p-interface (Many2Many)
      • -
    • TO l-interface (comprises lag-interface, Many2Many)
      • -
    • FROM generic-vnf (is composed of lag-interface)
      • -
    • FROM pserver (is composed of lag-interface)
      • -
    • FROM pnf (is composed of lag-interface)
      • -
    • FROM vpls-pe (is composed of lag-interface)
    +
  • TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
    • +
  • TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • +
  • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • +
  • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • +
  • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
    • @@ -154803,8 +173901,8 @@ 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
    +
  • 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)
    • @@ -154914,8 +174012,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for license group.

      -
    • FROM generic-vnf (is composed of license)
      • -
    • FROM vce (is composed of license)
    +
  • TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • @@ -155038,7 +174136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes a line-of-business

      -
    • TO generic-vnf (Many2Many)
    +
  • TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • @@ -155148,21 +174246,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical links generally connect l-interfaces but are used to express logical connectivity between two points

      -
    • TO lag-link (Many2Many)
      • -
    • TO pnf (Many2Many)
      • -
    • TO logical-link (One2Many)
      • -
    • TO generic-vnf (Many2Many)
      • -
    • TO pserver (Many2Many)
      • -
    • TO cloud-region (Many2Many)
      • -
    • TO vpn-binding (Many2Many)
      • -
    • FROM configuration
      • -
    • FROM l-interface
      • -
    • FROM lag-interface
      • -
    • FROM p-interface
      • -
    • FROM service-instance
      • -
    • FROM virtual-data-center
      • -
    • FROM vlan
      • -
    • FROM logical-link
    +
  • TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • +
  • TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
    • +
  • TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • +
  • TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
    • +
  • TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM 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)
    • @@ -155530,11 +174628,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Key/value pairs

      -
    • FROM configuration (is composed of metadatum)
      • -
    • FROM image (is composed of metadatum)
      • -
    • FROM model-ver (is composed of metadatum)
      • -
    • FROM service-instance (is composed of metadatum)
      • -
    • FROM connector (is composed of metadatum)
    +
  • 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 service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • @@ -155594,10 +174692,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

      -
    • TO model-ver (comprises model, One2Many)
      • -
    • FROM named-query
      • -
    • FROM named-query-element
      • -
    • FROM instance-group
    +
  • 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
    • @@ -155802,8 +174903,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO constrained-element-set (comprises model-constraint, One2Many)
      • -
    • FROM model-element (is composed of model-constraint)
    +
  • 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
    • @@ -155920,13 +175022,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Defines how other models combine to make up a higher-level model.

      -
    • TO model-ver (Many2One)
      • -
    • TO model-element (comprises model-element, One2Many)
      • -
    • TO model-constraint (comprises model-element, One2Many)
      • -
    • TO constrained-element-set (comprises model-element, One2Many)
      • -
    • FROM model-ver (is composed of model-element)
      • -
    • FROM element-choice-set (is composed of model-element)
      • -
    • FROM model-element (is composed of model-element)
    +
  • 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
    • @@ -156108,10 +175211,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

      -
    • TO model-element (comprises model-ver, One2Many)
      • -
    • TO metadatum (comprises model-ver, One2Many)
      • -
    • FROM model (is composed of model-ver)
      • -
    • FROM model-element
    +
  • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
    • +
  • MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
    • @@ -156335,7 +175440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM vlan
    +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
    • @@ -156508,8 +175613,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO model (One2Many)
      • -
    • TO named-query-element (comprises named-query, One2One)
    +
  • 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
    • @@ -156642,12 +175749,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO named-query-element (comprises named-query-element, Many2Many)
      • -
    • TO model (Many2One)
      • -
    • TO property-constraint (comprises named-query-element, One2Many)
      • -
    • TO related-lookup (comprises named-query-element, One2Many)
      • -
    • FROM named-query (is composed of named-query-element)
      • -
    • FROM named-query-element (is composed of named-query-element)
    +
  • 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
    • @@ -157204,6 +176312,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    + +
    + configurations: + object[] + + +
    +
    + +
    + +
    + configurations + + + +
    +
    @@ -157261,8 +176389,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM l3-network
      • -
    • FROM allotted-resource
    +
  • 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)
    • @@ -157355,7 +176483,7 @@ 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
    +
  • TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • @@ -157477,7 +176605,8 @@ 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)
    +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • NEWVCE is DELETED when these are DELETED L-INTERFACE
    • @@ -158043,9 +177172,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    OAM network, to be deprecated shortly. Do not use for new purposes.

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of oam-network)
    +
  • 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)
    • @@ -158191,6 +177320,182 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -158409,7 +177714,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes an owning-entity

      -
    • TO service-instance (One2Many)
    +
  • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
    • @@ -158491,14 +177796,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Physical interface (e.g., nic)

      -
    • TO l-interface (comprises p-interface, Many2Many)
      • -
    • TO physical-link (Many2Many)
      • -
    • TO logical-link (Many2One)
      • -
    • TO sriov-pf (comprises p-interface, One2One)
      • -
    • FROM lag-interface
      • -
    • FROM pserver (is composed of p-interface)
      • -
    • FROM pnf (is composed of p-interface)
      • -
    • FROM vpls-pe (is composed of p-interface)
    +
  • 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)
    • +
  • 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
    • @@ -158768,7 +178075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical connections, typically between p-interfaces

      -
    • FROM p-interface
    +
  • FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    • @@ -158998,7 +178305,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes a platform

      -
    • TO generic-vnf (Many2Many)
    +
  • TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • @@ -159108,15 +178415,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    PNF represents a physical network function. typically equipment used in the D1 world. 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 p-interface (comprises pnf, Many2Many)
      • -
    • TO lag-interface (comprises pnf, One2Many)
      • -
    • TO complex (Many2One)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO zone (Many2One)
      • -
    • FROM esr-thirdparty-sdnc
      • -
    • FROM generic-vnf
      • -
    • FROM logical-link
      • -
    • FROM service-instance
    +
  • 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)
    • +
  • PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    • @@ -159506,8 +178814,9 @@ 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)
    +
  • 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
    • @@ -159742,7 +179051,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes the project

      -
    • TO service-instance (One2Many)
    +
  • TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
    • @@ -159895,7 +179204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • FROM named-query-element (is composed of property-constraint)
    +
  • TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • @@ -160015,16 +179324,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

      -
    • TO complex (Many2One)
      • -
    • TO cloud-region (Many2One)
      • -
    • TO availability-zone (Many2One)
      • -
    • TO lag-interface (comprises pserver, Many2Many)
      • -
    • TO p-interface (comprises pserver, Many2Many)
      • -
    • TO zone (Many2One)
      • -
    • FROM generic-vnf
      • -
    • FROM group-assignment
      • -
    • FROM vserver
      • -
    • FROM logical-link
    +
  • 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
    • @@ -160535,7 +179847,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • FROM named-query-element (is composed of related-lookup)
    +
  • TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • @@ -160779,26 +180091,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    -
    - -
    - related-to-property: - object[] - - -
    -
    - -
    - -
    - related-to-property - - - -
    -
    @@ -161080,7 +180372,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack route table reference.

      -
    • FROM l3-network
    +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • @@ -161203,7 +180495,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Route target information

      -
    • FROM vpn-binding (is composed of route-target)
    +
  • TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • @@ -161325,8 +180617,9 @@ 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)
    +
  • 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
    • @@ -161771,7 +181064,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack segmentation assignment.

      -
    • FROM l3-network (is composed of segmentation-assignment)
    +
  • TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • @@ -162025,8 +181318,9 @@ 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
    +
  • 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
    • @@ -162229,26 +181523,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Instance of a service

      -
    • TO configuration (One2Many)
      • -
    • TO zone (Many2One)
      • -
    • TO cvlan-tag (Many2Many)
      • -
    • TO pnf (One2Many)
      • -
    • TO connector (Many2Many)
      • -
    • TO metadatum (comprises service-instance, Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • TO vlan (One2Many)
      • -
    • TO service-instance (One2Many)
      • -
    • TO ctag-assignment (One2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO allotted-resource (comprises service-instance, Many2Many)
      • -
    • TO allotted-resource (Many2Many)
      • -
    • FROM generic-vnf
      • -
    • FROM l3-network
      • -
    • FROM owning-entity
      • -
    • FROM project
      • -
    • FROM service-subscription (is composed of service-instance)
      • -
    • FROM vce
      • -
    • FROM service-instance
    +
  • 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)
    • +
  • 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 service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
    • +
  • SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -162329,6 +181625,45 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + 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 @@ -162628,9 +181963,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Object that group service instances.

      -
    • TO service-instance (comprises service-subscription, Many2Many)
      • -
    • FROM customer (is composed of service-subscription)
      • -
    • FROM tenant
    +
  • 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
    • @@ -162812,8 +182148,9 @@ 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)
    +
  • 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
    • @@ -162962,8 +182299,9 @@ 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
    +
  • 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
    • @@ -163134,8 +182472,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack snapshot

      -
    • FROM cloud-region (is composed of snapshot)
      • -
    • FROM vserver
    +
  • TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
    • @@ -163353,8 +182691,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    SR-IOV Physical Function

      -
    • FROM p-interface (is composed of sriov-pf)
      • -
    • FROM sriov-vf
    +
  • 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)
    • @@ -163464,8 +182802,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    SR-IOV Virtual Function (not to be confused with virtual network function)

      -
    • TO sriov-pf (Many2One)
      • -
    • FROM l-interface (is composed of sriov-vf)
    +
  • 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)
    • @@ -163757,12 +183095,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO host-route (comprises subnet, One2Many)
      • -
    • FROM l3-interface-ipv4-address-list
      • -
    • FROM l3-interface-ipv6-address-list
      • -
    • FROM l3-network (is composed of subnet)
      • -
    • FROM vip-ipv4-address-list
      • -
    • FROM vip-ipv6-address-list
    +
  • 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
    • @@ -164081,12 +183421,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack tenant

      -
    • TO l3-network (Many2Many)
      • -
    • TO service-subscription (Many2Many)
      • -
    • TO vserver (comprises tenant, One2Many)
      • -
    • FROM cloud-region (is composed of tenant)
      • -
    • FROM group-assignment
      • -
    • FROM volume-group
    +
  • 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
    • @@ -164241,7 +183582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

      -
    • FROM allotted-resource (is composed of tunnel-xconnect)
    +
  • TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    • @@ -164526,13 +183867,14 @@ 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)
      • -
    • TO entitlement (comprises vce, One2Many)
      • -
    • TO license (comprises vce, One2Many)
    +
  • 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
    • @@ -164908,11 +184250,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    a deployment unit of VNFCs

      -
    • TO volume-group (One2One)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO vnfc (One2Many)
      • -
    • FROM vserver
      • -
    • FROM generic-vnf (is composed of vf-module)
    +
  • TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • +
  • TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
    • +
  • TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
    • +
  • VF-MODULE cannot be deleted if linked to VNFC
    • @@ -165178,7 +184521,7 @@ 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)
    +
  • TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
    • @@ -165308,10 +184651,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

      -
    • TO instance-group (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM vnfc
      • -
    • FROM cloud-region (is composed of vip-ipv4-address-list)
    +
  • 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)
    • @@ -165452,10 +184795,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

      -
    • TO instance-group (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM vnfc
      • -
    • FROM cloud-region (is composed of vip-ipv6-address-list)
    +
  • 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)
    • @@ -165596,9 +184939,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual organization of cloud infrastructure elements in a data center context

      -
    • TO generic-vnf (Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • FROM connector
    +
  • 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)
    • @@ -165721,13 +185064,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Definition of vlan

      -
    • TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
      • -
    • TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
      • -
    • TO multicast-configuration (Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • FROM l-interface (is composed of vlan)
      • -
    • FROM service-instance
      • -
    • FROM allotted-resource
    +
  • 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
    • @@ -166039,7 +185384,8 @@ 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
    +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
    • @@ -166198,14 +185544,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO instance-group (Many2Many)
      • -
    • TO vip-ipv4-address-list (Many2Many)
      • -
    • TO vip-ipv6-address-list (Many2Many)
      • -
    • FROM vserver
      • -
    • FROM vf-module
      • -
    • FROM generic-vnf
      • -
    • FROM l3-interface-ipv4-address-list (comprises vnfc)
      • -
    • FROM l3-interface-ipv6-address-list (comprises vnfc)
    +
  • 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
    • @@ -166477,7 +185824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Ephemeral Block storage volume.

      -
    • FROM vserver (is composed of volume)
    +
  • FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
    • @@ -166559,11 +185906,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persistent block-level storage.

      -
    • TO complex (Many2Many)
      • -
    • TO tenant (Many2Many)
      • -
    • FROM cloud-region (is composed of volume-group)
      • -
    • FROM vf-module
      • -
    • FROM generic-vnf
    +
  • 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)
    • @@ -166788,10 +186135,11 @@ 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)
    +
  • 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
    • @@ -166988,10 +186336,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPN binding

      -
    • TO route-target (comprises vpn-binding, One2Many)
      • -
    • FROM l3-network
      • -
    • FROM logical-link
      • -
    • FROM allotted-resource
    +
  • 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
    • @@ -167190,17 +186540,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual Servers, aka virtual machine or VM.

      -
    • TO flavor (Many2One)
      • -
    • TO image (Many2One)
      • -
    • TO l-interface (comprises vserver, Many2Many)
      • -
    • TO pserver (Many2One)
      • -
    • TO volume (comprises vserver, Many2Many)
      • -
    • TO vnfc (Many2Many)
      • -
    • TO snapshot (One2One)
      • -
    • TO vf-module (Many2One)
      • -
    • FROM generic-vnf
      • -
    • FROM tenant (is composed of vserver)
      • -
    • FROM vce
    +
  • 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
    • @@ -167424,11 +186776,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    A zone is a grouping of assets in a location homing to the same connections into the CBB

      -
    • TO complex (Many2One)
      • -
    • FROM cloud-region
      • -
    • FROM pserver
      • -
    • FROM pnf
      • -
    • FROM service-instance
    +
  • 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)
    • 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 d4cfa0c8..be07b77b 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 @@ -15,7 +15,10 @@

    Active and Available Inventory REST API.

    Version: v12

    -

    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
    +


    +[Differences versus the previous schema version](apidocs/aai_swagger_v8.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.

    @@ -61,6 +64,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    create or update an existing pserver

    +
    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    update an existing pserver
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /business/connectors/connector/{resource-instance-id}

    create or update an existing connector

    +
    PATCH /business/connectors/connector/{resource-instance-id}

    update an existing connector
    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
    PUT /business/customers/customer/{global-customer-id}

    create or update an existing customer

    +
    PATCH /business/customers/customer/{global-customer-id}

    update an existing customer
    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
    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
    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
    PUT /service-design-and-creation/models/model/{model-name-version-id}

    create or update an existing model

    +
    PATCH /service-design-and-creation/models/model/{model-name-version-id}

    update an existing model
    PUT /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    create or update an existing metadatum

    +
    PATCH /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    update an existing metadatum
    PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

    create or update an existing model-element

    +
    PATCH /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

    update an existing model-element
    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}

    create or update an existing model-constraint

    +
    PATCH /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

    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}/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-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}

    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}/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-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}

    update an existing element-choice-set
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/newvces/newvce/{vnf-id2}

    create or update an existing newvce

    +
    PATCH /network/newvces/newvce/{vnf-id2}

    update an existing newvce
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/pnfs/pnf/{pnf-name}

    create or update an existing pnf

    +
    PATCH /network/pnfs/pnf/{pnf-name}

    update an existing pnf
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/vces/vce/{vnf-id}

    create or update an existing vce

    +
    PATCH /network/vces/vce/{vnf-id}

    update an existing vce
    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
    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
    PUT /network/vnfcs/vnfc/{vnfc-name}

    create or update an existing vnfc

    +
    PATCH /network/vnfcs/vnfc/{vnfc-name}

    update an existing vnfc
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    + + + + + + + + + + + + + + + + + + +
    + resource-instance-id + +

    Unique id of resource instance.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -4567,7 +5359,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /metadata
    @@ -4737,7 +5529,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadatum
    @@ -4784,7 +5576,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnectorMetadataMetadatum.json)

    @@ -4870,16 +5662,120 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing metadatum
    -

    DELETE /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

    +
    update an existing metadatum
    +

    PATCH /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

    Tags: Business
    -

    delete an existing metadatum

    +

    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

    @@ -4996,7 +5892,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)

    @@ -5179,7 +6075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /customers + /customers
    @@ -5304,7 +6200,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /customer + /customer
    @@ -5351,7 +6247,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    customer object that needs to be created or updated

    +

    customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)

    @@ -5421,6 +6317,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing customer
    +

    PATCH /business/customers/customer/{global-customer-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -5533,7 +6518,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)

    @@ -5777,7 +6762,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-subscriptions + /service-subscriptions
    @@ -5918,7 +6903,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-subscription + /service-subscription
    @@ -5965,7 +6950,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-subscription object that needs to be created or updated

    +

    service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

    @@ -6052,22 +7037,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing service-subscription
    -

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    +
    update an existing service-subscription
    +

    PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    delete an existing service-subscription

    +

    update an existing service-subscription

    application/json application/xml

    +
    +
    +

    service-subscription object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /service-subscription +
    +
    +
    @@ -6113,22 +7110,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -6160,35 +7141,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    +
    delete an existing service-subscription
    +

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    see node definition for valid relationships

    +

    delete an existing service-subscription

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -6234,6 +7203,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -6266,16 +7251,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    Tags: Business
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -6471,7 +7561,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-instances + /service-instances
    @@ -6718,7 +7808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-instance + /service-instance
    @@ -6765,7 +7855,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-instance object that needs to be created or updated

    +

    service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

    @@ -6867,6 +7957,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -7211,7 +8422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /metadata
    @@ -7473,7 +8684,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadatum
    @@ -7520,7 +8731,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)

    @@ -7638,22 +8849,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing metadatum

    +

    update an existing metadatum

    application/json application/xml

    +
    +
    +

    metadatum object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /metadatum +
    +
    +
    @@ -7730,22 +8953,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -7777,35 +8984,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing metadatum

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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 + + + +
    + 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/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -8043,7 +9390,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cloud-regions + /cloud-regions
    @@ -8184,7 +9531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cloud-region + /cloud-region
    @@ -8231,7 +9578,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cloud-region object that needs to be created or updated

    +

    cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)

    @@ -8317,6 +9664,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -8539,7 +9991,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /availability-zones + /availability-zones
    @@ -8696,7 +10148,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /availability-zone + /availability-zone
    @@ -8743,7 +10195,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    availability-zone object that needs to be created or updated

    +

    availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

    @@ -8846,16 +10298,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing availability-zone
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

    +
    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
    -

    delete an existing availability-zone

    +

    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

    @@ -8989,7 +10562,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

    @@ -9313,7 +10886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /dvs-switches + /dvs-switches
    @@ -9485,7 +11058,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /dvs-switch + /dvs-switch
    @@ -9532,7 +11105,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    dvs-switch object that needs to be created or updated

    +

    dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

    @@ -9635,22 +11208,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing dvs-switch
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

    +
    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
    -

    delete an existing dvs-switch

    +

    update an existing dvs-switch

    application/json application/xml

    +
    +
    +

    dvs-switch object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /dvs-switch +
    +
    +
    @@ -9712,22 +11297,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -9759,35 +11328,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing dvs-switch

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -9849,107 +11406,244 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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 + resource-version -

    DVS switch name

    +

    resource-version for concurrency

    		pathquery + 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/v8/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 @@ -10102,7 +11796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /flavors + /flavors
    @@ -10274,7 +11968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /flavor + /flavor
    @@ -10321,7 +12015,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    flavor object that needs to be created or updated

    +

    flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -10424,22 +12118,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing flavor
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    +
    update an existing flavor
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    Tags: CloudInfrastructure
    -

    delete an existing flavor

    +

    update an existing flavor

    application/json application/xml

    +
    +
    +

    flavor object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /flavor +
    +
    +
    @@ -10501,22 +12207,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -10567,7 +12382,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -10891,7 +12706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignments + /group-assignments
    @@ -11078,7 +12893,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignment + /group-assignment
    @@ -11125,7 +12940,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    group-assignment object that needs to be created or updated

    +

    group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    @@ -11228,141 +13043,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing group-assignment
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    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
    -

    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

    +

    update an existing group-assignment

    @@ -11371,13 +13061,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

    +

    group-assignment object that needs to be created or updated.

    - /relationship + /group-assignment
    @@ -11473,17 +13163,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

    +
    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 relationship

    +

    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/v8/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

    @@ -11695,7 +13631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /images + /images
    @@ -11912,7 +13848,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /image + /image
    @@ -11959,7 +13895,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    image object that needs to be created or updated

    +

    image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

    @@ -12062,16 +13998,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing image
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    +
    update an existing image
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    Tags: CloudInfrastructure
    -

    delete an existing image

    +

    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

    @@ -12375,7 +14432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /metadata
    @@ -12607,7 +14664,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadatum
    @@ -12654,7 +14711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

    @@ -12771,6 +14828,142 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing metadatum
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -12930,7 +15123,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

    @@ -13254,7 +15447,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /oam-networks + /oam-networks
    @@ -13441,7 +15634,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /oam-network + /oam-network
    @@ -13488,7 +15681,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    oam-network object that needs to be created or updated

    +

    oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

    @@ -13591,22 +15784,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing oam-network
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

    +
    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
    -

    delete an existing oam-network

    +

    update an existing oam-network

    application/json application/xml

    +
    +
    +

    oam-network object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /oam-network +
    +
    +
    @@ -13668,22 +15873,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -13734,7 +16048,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

    @@ -13964,7 +16278,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegion.json)

    @@ -14256,7 +16570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /snapshots + /snapshots
    @@ -14488,7 +16802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /snapshot + /snapshot
    @@ -14535,7 +16849,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    snapshot object that needs to be created or updated

    +

    snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    @@ -14638,141 +16952,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing snapshot
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    update an existing snapshot
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    delete an existing snapshot

    - -
    -
    - -

    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

    +

    update an existing snapshot

    @@ -14781,13 +16970,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

    +

    snapshot object that needs to be created or updated.

    - /relationship + /snapshot
    @@ -14883,17 +17072,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    +
    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 relationship

    +

    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/v8/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

    @@ -15105,7 +17540,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tenants + /tenants
    @@ -15277,7 +17712,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tenant + /tenant
    @@ -15324,7 +17759,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    tenant object that needs to be created or updated

    +

    tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    @@ -15427,16 +17862,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing tenant
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    update an existing tenant
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    delete an existing tenant

    +

    update an existing tenant

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    tenant object that needs to be 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

    @@ -15570,7 +18126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    @@ -15925,7 +18481,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vservers + /vservers
    @@ -16186,7 +18742,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vserver + /vserver
    @@ -16233,7 +18789,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vserver object that needs to be created or updated

    +

    vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    @@ -16351,6 +18907,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vserver
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -16725,7 +19418,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -17047,7 +19740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -17094,7 +19787,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

    @@ -17229,22 +19922,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l-interface
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -17338,22 +20043,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -17740,7 +20586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -17787,7 +20633,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -17938,22 +20784,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: CloudInfrastructure
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -18063,22 +20921,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -18110,35 +20952,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -18248,6 +21078,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -18280,22 +21126,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/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
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -18436,17 +21294,174 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    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

    @@ -18791,7 +21806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -18838,7 +21853,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -18989,22 +22004,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -19114,22 +22141,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -19161,35 +22172,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -19299,6 +22298,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -19331,22 +22346,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -19487,35 +22514,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -19609,6 +22624,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -19641,22 +22672,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -19781,19 +22824,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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
    -

    returns sriov-vfs

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -19886,169 +22934,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., DCP, LCP)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -20058,29 +22943,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -20103,17 +22965,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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-vf

    +

    returns sriov-vfs

    @@ -20208,22 +23070,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -     		path - string - - - -
    cloud-type @@ -20387,66 +23233,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -20473,7 +23259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vfs
    @@ -20502,35 +23288,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing sriov-vf
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    returns 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
    -

    create or update an existing sriov-vf

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    sriov-vf object that needs to be created or updated

    -

    -
    -
    -
    -
    - /sriov-vf -
    -
    -
    -
    @@ -20639,169 +23408,220 @@ 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 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -20821,6 +23640,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -20843,17 +23685,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    create or update an existing sriov-vf
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    create or update an existing sriov-vf

    @@ -20862,13 +23704,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

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /relationship + /sriov-vf
    @@ -21012,23 +23854,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    - cloud-owner + cloud-type -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - cloud-region-id + owner-defined-type -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Cloud-owner defined type indicator (e.g., DCP, LCP)

    		pathquery string -
    - tenant-id + tenant-name -

    Unique id relative to the cloud-region.

    +

    Readable name of tenant

    		pathquery string -
    - vserver-id + vserver-name -

    Unique identifier for this vserver relative to its tenant

    +

    Name of vserver

    		pathquery string -
    - interface-name + vserver-name2 -

    Name given to the interface

    +

    Alternative name of vserver

    		pathquery string -
    - pci-id + prov-status -

    PCI ID used to identify the sriov-vf

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - resource-version + in-maint -

    resource-version for concurrency

    +     		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 @@ -20809,7 +23629,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -21169,19 +24023,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    @@ -21276,25 +24135,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - cloud-type + pci-id -

    Type of the cloud (e.g., openstack)

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - owner-defined-type + resource-version -

    Cloud-owner defined type indicator (e.g., DCP, LCP)

    +

    resource-version for concurrency

    		 query @@ -21302,139 +24162,333 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + - + - + + +
    - tenant-name + cloud-owner -

    Readable name of tenant

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		querypath string +
    - vserver-name + cloud-region-id -

    Name of vserver

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - vserver-name2 + tenant-id -

    Alternative name of vserver

    +

    Unique id relative to the cloud-region.

    		querypath string +
    - prov-status + vserver-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique identifier for this vserver relative to its tenant

    		querypath string +
    - in-maint + interface-name +

    Name given to the interface

    		querypath - boolean + string +
    - is-closed-loop-disabled + pci-id +

    PCI ID used to identify the sriov-vf

    		querypath - boolean + string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +

    +
    +
    + + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + + + + + + @@ -21446,29 +24500,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -21491,17 +24522,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    returns vlans

    @@ -21596,22 +24627,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - -
    - interface-id + cloud-owner -

    ID of interface

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		querypath string +
    - macaddr + cloud-region-id -

    MAC address for the interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - network-name + tenant-id -

    Name of the network

    +

    Unique id relative to the cloud-region.

    		querypath + string + + + +
    + 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 + + +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    cloud-type @@ -21775,36 +24790,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -21831,7 +24816,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlans
    @@ -21860,35 +24845,572 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing vlan
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns vlan
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    create or update an existing vlan

    +

    returns 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 + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., DCP, LCP)

    +     		query + string + + +
    + tenant-name + +

    Readable name of tenant

    +     		query + string + + +
    + vserver-name + +

    Name of vserver

    +     		query + string + + +
    + vserver-name2 + +

    Alternative name of vserver

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    +
    + +
    +

    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/v8/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 +
    +
    +
    +
    @@ -22602,7 +26124,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -22649,7 +26171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -22816,22 +26338,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -22957,22 +26491,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -23004,35 +26522,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -23158,6 +26664,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -23190,16 +26712,201 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -23763,7 +27470,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -23810,7 +27517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -23977,22 +27684,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -24118,22 +27837,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -24165,35 +27868,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -24319,6 +28010,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -24351,16 +28058,201 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -24542,7 +28434,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    @@ -24868,7 +28760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    @@ -25344,7 +29236,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volumes + /volumes
    @@ -25621,7 +29513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volume + /volume
    @@ -25668,7 +29560,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume object that needs to be created or updated

    +

    volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    @@ -25803,22 +29695,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing volume
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    update an existing volume
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    delete an existing volume

    +

    update an existing volume

    application/json application/xml

    +
    +
    +

    volume object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /volume +
    +
    +
    @@ -25912,22 +29816,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -25959,35 +29847,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +
    delete an existing volume
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing volume

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -26081,6 +29957,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -26113,16 +30005,169 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -26366,7 +30411,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volume-groups + /volume-groups
    @@ -26568,7 +30613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volume-group + /volume-group
    @@ -26615,7 +30660,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume-group object that needs to be created or updated

    +

    volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    @@ -26717,6 +30762,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing volume-group
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -26861,7 +31027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    @@ -27108,7 +31274,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /complexes + /complexes
    @@ -27248,7 +31414,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /complex + /complex
    @@ -27295,7 +31461,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    complex object that needs to be created or updated

    +

    complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplex.json)

    @@ -27366,16 +31532,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing complex
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

    +
    update an existing complex
    +

    PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    delete an existing complex

    +

    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

    @@ -27570,7 +31825,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-pools + /ctag-pools
    @@ -27742,7 +31997,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-pool + /ctag-pool
    @@ -27789,7 +32044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-pool object that needs to be created or updated

    +

    ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

    @@ -27892,22 +32147,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing ctag-pool
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    update an existing ctag-pool
    +

    PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    Tags: CloudInfrastructure
    -

    delete an existing ctag-pool

    +

    update an existing ctag-pool

    application/json application/xml

    +
    +
    +

    ctag-pool object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /ctag-pool +
    +
    +
    @@ -27969,22 +32236,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -28016,35 +32267,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

    +
    delete an existing ctag-pool
    +

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing ctag-pool

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -28106,6 +32345,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -28138,22 +32393,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -28246,100 +32513,209 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    see node definition for valid relationships

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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

    +

    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/v8/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
    @@ -28448,7 +32824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-profiles + /network-profiles
    @@ -28543,7 +32919,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-profile + /network-profile
    @@ -28590,7 +32966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-profile object that needs to be created or updated

    +

    network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)

    @@ -28660,6 +33036,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing network-profile
    +

    PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -28772,7 +33237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureNetworkProfilesNetworkProfile.json)

    @@ -28955,7 +33420,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pservers + /pservers
    @@ -29094,7 +33559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pserver + /pserver
    @@ -29141,7 +33606,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    pserver object that needs to be created or updated

    +

    pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)

    @@ -29211,6 +33676,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing pserver
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -29415,7 +33969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /lag-interfaces
    @@ -29570,7 +34124,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /lag-interface
    @@ -29617,7 +34171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

    @@ -29704,22 +34258,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing lag-interface
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    +
    update an existing lag-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    delete an existing lag-interface

    +

    update an existing lag-interface

    application/json application/xml

    +
    +
    +

    lag-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    @@ -29765,22 +34331,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -29812,19 +34362,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +
    delete an existing lag-interface
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns l-interfaces

    +

    delete an existing lag-interface

    +
    + +

    application/json application/xml +

    +
    @@ -29871,39 +34426,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -29922,29 +34449,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -29967,17 +34471,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns l-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: CloudInfrastructure
    -

    returns l-interface

    +

    returns l-interfaces

    @@ -30024,22 +34528,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 + resource-version -

    alternative pserver name

    +

    resource-version for concurrency

    		 query @@ -29911,6 +34437,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    pserver-id @@ -30084,51 +34572,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -30155,7 +34598,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interfaces
    @@ -30184,35 +34627,372 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing l-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns l-interface
    +

    GET /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

    +

    returns 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 + + + +
    + 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 + + +
    + 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/v8/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 +
    +
    +
    +
    @@ -30678,7 +35458,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -30725,7 +35505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -30844,22 +35624,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -30937,22 +35729,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -30984,35 +35760,176 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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 + + + +
    + 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/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -31495,7 +36412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -31542,7 +36459,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -31661,22 +36578,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -31754,22 +36683,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -31801,35 +36714,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -31907,6 +36808,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -31939,22 +36856,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -32063,35 +36992,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -32481,7 +37535,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -32773,7 +37827,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -32820,7 +37874,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -32938,6 +37992,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing sriov-vf
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -33098,7 +38289,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -33529,7 +38720,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -33791,7 +38982,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -33838,7 +39029,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -33956,6 +39147,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vlan
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -34392,7 +39720,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -34439,7 +39767,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -34573,6 +39901,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -34749,7 +40230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -35319,7 +40800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -35366,7 +40847,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -35500,6 +40981,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -35676,7 +41310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -35970,7 +41604,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -36232,7 +41866,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

    @@ -36522,7 +42156,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /p-interfaces + /p-interfaces
    @@ -36677,7 +42311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /p-interface + /p-interface
    @@ -36724,7 +42358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated

    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    @@ -36811,22 +42445,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing p-interface
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    update an existing p-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    delete an existing p-interface

    +

    update an existing p-interface

    application/json application/xml

    +
    +
    +

    p-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    @@ -36872,22 +42518,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -36919,19 +42549,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    delete an existing p-interface
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns l-interfaces

    +

    delete an existing p-interface

    +
    + +

    application/json application/xml +

    +
    @@ -36978,39 +42613,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -37029,29 +42636,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -37074,17 +42658,172 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns l-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: CloudInfrastructure
    -

    returns l-interface

    +

    returns l-interfaces

    + +
    +
    +
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 + resource-version -

    alternative pserver name

    +

    resource-version for concurrency

    		 query @@ -37018,6 +42624,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + hostname + +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + 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

    + +
    +
    +
    + +
    +
    + +
    + /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

    @@ -37262,7 +43001,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -37309,7 +43048,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -37411,6 +43150,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -37785,7 +43645,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -37832,7 +43692,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -37951,22 +43811,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -38044,22 +43916,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -38091,35 +43947,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -38197,6 +44041,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -38229,22 +44089,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -38353,19 +44225,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -38428,7 +44305,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -38442,140 +44319,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    - 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 - - -
    @@ -38585,29 +44328,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv6-address-list -
    -
    -
    - -
    default @@ -38631,35 +44351,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns 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 -
    -
    -
    -
    @@ -38736,6 +44439,140 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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 + + +
    + 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 + + +
    @@ -38745,6 +44582,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -38768,22 +44628,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    create or update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -38861,22 +44733,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -38908,17 +44764,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -38927,13 +44783,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -39045,17 +44901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -39139,6 +44995,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -39170,11 +45042,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -39189,7 +45061,269 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -39588,7 +45722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -39880,7 +46014,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -39927,7 +46061,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -40046,16 +46180,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing sriov-vf
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    delete an existing sriov-vf

    +

    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

    @@ -40205,7 +46476,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -40636,7 +46907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -40898,7 +47169,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -40945,7 +47216,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -41063,6 +47334,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vlan
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -41499,7 +47907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -41546,7 +47954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -41681,16 +48089,169 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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

    @@ -41856,7 +48417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -42426,7 +48987,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -42473,7 +49034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -42608,22 +49169,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -42717,22 +49290,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -42764,35 +49321,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -42886,6 +49431,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -42918,22 +49479,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -43058,35 +49631,176 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -43339,7 +50053,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    @@ -43537,7 +50251,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)

    @@ -43720,7 +50434,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /virtual-data-centers + /virtual-data-centers
    @@ -43830,7 +50544,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /virtual-data-center + /virtual-data-center
    @@ -43877,7 +50591,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    virtual-data-center object that needs to be created or updated

    +

    virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

    @@ -43947,6 +50661,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing virtual-data-center
    +

    PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -44059,7 +50862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

    @@ -44242,7 +51045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /generic-vnfs + /generic-vnfs
    @@ -44530,7 +51333,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /generic-vnf + /generic-vnf
    @@ -44577,7 +51380,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    generic-vnf object that needs to be created or updated

    +

    generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)

    @@ -44648,22 +51451,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing generic-vnf
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    update an existing generic-vnf
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    delete an existing generic-vnf

    +

    update an existing generic-vnf

    application/json application/xml

    +
    +
    +

    generic-vnf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /generic-vnf +
    +
    +
    @@ -44693,22 +51508,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -44740,17 +51539,110 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

    +
    delete an existing generic-vnf
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    returns l-interfaces

    +

    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 l-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

    + Tags: + Network +
    +
    +
    +

    returns l-interfaces

    @@ -45000,7 +51892,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -45349,7 +52241,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -45396,7 +52288,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

    @@ -45482,6 +52374,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l-interface
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -45973,7 +52970,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -46020,7 +53017,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -46123,22 +53120,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -46200,22 +53209,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -46247,35 +53240,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -46337,6 +53318,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -46369,16 +53366,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -46859,7 +53977,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -46906,7 +54024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -47009,22 +54127,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -47086,22 +54216,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -47133,35 +54247,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -47223,107 +54325,244 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery + 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/v8/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 @@ -47382,7 +54621,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

    @@ -47882,7 +55121,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -48307,7 +55546,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -48354,7 +55593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -48457,22 +55696,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing sriov-vf

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -48534,22 +55785,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -48600,7 +55960,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -49132,7 +56492,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -49527,7 +56887,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -49574,7 +56934,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

    @@ -49676,6 +57036,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -50229,7 +57710,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -50276,7 +57757,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -50395,22 +57876,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -50488,22 +57981,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - resource-version - -

    resource-version for concurrency

    -     		query - 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 + + + +
    @@ -50554,7 +58172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -51225,7 +58843,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -51272,7 +58890,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -51391,22 +59009,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
    +

    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -51484,22 +59114,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -51531,35 +59145,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -51637,6 +59239,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -51669,22 +59287,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -51793,35 +59423,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -52283,7 +60038,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /lag-interfaces
    @@ -52587,7 +60342,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /lag-interface
    @@ -52634,7 +60389,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

    @@ -52720,6 +60475,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -53105,7 +60965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -53470,7 +61330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -53517,7 +61377,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -53620,22 +61480,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l-interface
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -53697,22 +61569,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -53744,17 +61600,142 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    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

    @@ -54142,7 +62123,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -54189,7 +62170,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -54307,6 +62288,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -54467,7 +62585,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -55108,7 +63226,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -55155,7 +63273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -55274,16 +63392,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be 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

    @@ -55433,7 +63688,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -55695,7 +63950,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -56243,7 +64498,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -56684,7 +64939,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -56731,7 +64986,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -56849,6 +65104,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -57009,7 +65401,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -57589,7 +65981,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -58000,7 +66392,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -58047,7 +66439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -58166,16 +66558,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing vlan

    +

    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

    @@ -58750,7 +67279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -58797,7 +67326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -58931,6 +67460,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -59107,7 +67789,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -59826,7 +68508,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -59873,7 +68555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -60007,6 +68689,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -60183,7 +69018,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -60477,7 +69312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -60739,7 +69574,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

    @@ -60937,7 +69772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)

    @@ -61344,7 +70179,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vf-modules + /vf-modules
    @@ -61753,7 +70588,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vf-module + /vf-module
    @@ -61800,7 +70635,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vf-module object that needs to be created or updated

    +

    vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    @@ -61886,6 +70721,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vf-module
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -62014,7 +70954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    @@ -62229,7 +71169,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ipsec-configurations + /ipsec-configurations
    @@ -62324,7 +71264,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ipsec-configuration + /ipsec-configuration
    @@ -62371,7 +71311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ipsec-configuration object that needs to be created or updated

    +

    ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)

    @@ -62442,16 +71382,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing ipsec-configuration
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    +
    update an existing ipsec-configuration
    +

    PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    Tags: Network
    -

    delete an existing ipsec-configuration

    +

    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

    @@ -62553,7 +71582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)

    @@ -62767,7 +71796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vig-servers + /vig-servers
    @@ -62878,7 +71907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vig-server + /vig-server
    @@ -62925,7 +71954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vig-server object that needs to be created or updated

    +

    vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

    @@ -63011,6 +72040,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vig-server
    +

    PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -63139,7 +72273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

    @@ -63354,7 +72488,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-networks + /l3-networks
    @@ -63569,7 +72703,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-network + /l3-network
    @@ -63616,7 +72750,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-network object that needs to be created or updated

    +

    l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)

    @@ -63686,6 +72820,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-network
    +

    PATCH /network/l3-networks/l3-network/{network-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -63966,7 +73189,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-assignments + /ctag-assignments
    @@ -64197,7 +73420,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-assignment + /ctag-assignment
    @@ -64244,7 +73467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-assignment object that needs to be created or updated

    +

    ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

    @@ -64330,6 +73553,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing ctag-assignment
    +

    PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -64458,7 +73786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

    @@ -64656,7 +73984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)

    @@ -64990,7 +74318,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /segmentation-assignments + /segmentation-assignments
    @@ -65221,7 +74549,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /segmentation-assignment + /segmentation-assignment
    @@ -65268,7 +74596,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    segmentation-assignment object that needs to be created or updated

    +

    segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

    @@ -65355,22 +74683,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing segmentation-assignment
    -

    DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    +
    update an existing segmentation-assignment
    +

    PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    Tags: Network
    -

    delete an existing segmentation-assignment

    +

    update an existing segmentation-assignment

    application/json application/xml

    +
    +
    +

    segmentation-assignment object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /segmentation-assignment +
    +
    +
    @@ -65416,22 +74756,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -65463,35 +74787,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

    +
    delete an existing segmentation-assignment
    +

    DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing segmentation-assignment

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -65537,91 +74849,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /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 + resource-version -

    Route Table Reference id, UUID assigned to this instance.

    +

    resource-version for concurrency

    		pathquery string @@ -65661,17 +74896,215 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns subnets
    -

    GET /network/l3-networks/l3-network/{network-id}/subnets

    +
    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
    -

    returns subnets

    +

    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/v8/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

    @@ -65848,7 +75281,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /subnets + /subnets
    @@ -66094,7 +75527,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /subnet + /subnet
    @@ -66141,7 +75574,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    subnet object that needs to be created or updated

    +

    subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

    @@ -66228,22 +75661,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing subnet
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    +
    update an existing subnet
    +

    PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    Tags: Network
    -

    delete an existing subnet

    +

    update an existing subnet

    application/json application/xml

    +
    +
    +

    subnet object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /subnet +
    +
    +
    @@ -66289,22 +75734,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -66336,35 +75765,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    +
    delete an existing subnet
    +

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing subnet

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -66410,6 +75827,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -66442,16 +75875,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -66570,7 +76108,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-links + /lag-links
    @@ -66665,7 +76203,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-link + /lag-link
    @@ -66712,7 +76250,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-link object that needs to be created or updated

    +

    lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)

    @@ -66782,6 +76320,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -66894,7 +76521,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)

    @@ -67077,7 +76704,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /logical-links + /logical-links
    @@ -67247,7 +76874,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /logical-link + /logical-link
    @@ -67294,7 +76921,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    logical-link object that needs to be created or updated

    +

    logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)

    @@ -67364,6 +76991,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -67476,7 +77192,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)

    @@ -67659,7 +77375,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /multicast-configurations + /multicast-configurations
    @@ -67754,7 +77470,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /multicast-configuration + /multicast-configuration
    @@ -67801,7 +77517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    multicast-configuration object that needs to be created or updated

    +

    multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)

    @@ -67871,6 +77587,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -67983,7 +77788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)

    @@ -68166,7 +77971,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-policies + /network-policies
    @@ -68276,7 +78081,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-policy + /network-policy
    @@ -68323,7 +78128,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-policy object that needs to be created or updated

    +

    network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)

    @@ -68393,6 +78198,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -68505,7 +78399,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)

    @@ -68688,7 +78582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /newvces + /newvces
    @@ -68858,7 +78752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /newvce + /newvce
    @@ -68905,7 +78799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    newvce object that needs to be created or updated

    +

    newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)

    @@ -68975,6 +78869,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing newvce
    +

    PATCH /network/newvces/newvce/{vnf-id2}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -69210,7 +79193,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /l-interfaces
    @@ -69441,7 +79424,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interface
    @@ -69488,7 +79471,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)

    @@ -69575,16 +79558,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l-interface
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    +
    update an existing l-interface
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    delete an existing l-interface

    +

    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

    @@ -69947,7 +80035,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -69994,7 +80082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -70096,6 +80184,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -70240,7 +80449,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -70715,7 +80924,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -70762,7 +80971,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -70865,22 +81074,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -70942,22 +81163,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -70989,35 +81194,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -71079,6 +81272,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -71111,22 +81320,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -71219,35 +81440,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -71293,6 +81502,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -71325,22 +81550,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -71417,19 +81654,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    delete an existing relationship
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    returns sriov-vfs

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -71474,126 +81716,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC 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 - - -
    @@ -71603,29 +81725,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -71648,17 +81747,248 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    returns sriov-vfs
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: Network
    -

    returns sriov-vf

    +

    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 and clients should expect changes to occur in the future to this field as ASDC 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

    @@ -71927,7 +82257,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -71974,7 +82304,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -72077,22 +82407,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing sriov-vf
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    delete an existing sriov-vf

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -72154,22 +82496,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -72201,35 +82527,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -72291,6 +82605,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -72323,22 +82653,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -72431,19 +82773,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -72490,122 +82837,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -72617,29 +82860,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -72662,17 +82882,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns vlans
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns vlan

    +

    returns vlans

    @@ -72719,22 +82939,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - -
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC 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 + pci-id -

    Name of the network

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    vnf-name @@ -72855,36 +83059,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -72911,7 +83085,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlans
    @@ -72940,35 +83114,433 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing vlan
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns vlan
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    create or update an existing vlan

    +

    returns 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 + + + +
    + 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 + + +
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    +
    + +
    +

    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/v8/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 +
    +
    +
    +
    @@ -73495,7 +84067,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -73542,7 +84114,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -73661,22 +84233,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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
    +

    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -73754,22 +84338,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -73801,35 +84369,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -73907,6 +84463,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -73939,16 +84511,153 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -74373,7 +85082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -74420,7 +85129,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -74539,22 +85248,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -74632,22 +85353,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -74679,35 +85384,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -74785,6 +85478,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -74817,22 +85526,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -74941,35 +85662,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -75031,6 +85740,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -75063,16 +85788,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/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

    @@ -75190,7 +86036,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)

    @@ -75373,7 +86219,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /physical-links + /physical-links
    @@ -75483,7 +86329,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /physical-link + /physical-link
    @@ -75530,7 +86376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    physical-link object that needs to be created or updated

    +

    physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)

    @@ -75600,6 +86446,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -75712,7 +86647,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)

    @@ -75895,7 +86830,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pnfs + /pnfs
    @@ -76005,7 +86940,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pnf + /pnf
    @@ -76052,7 +86987,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    pnf object that needs to be created or updated

    +

    pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)

    @@ -76123,22 +87058,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing pnf
    -

    DELETE /network/pnfs/pnf/{pnf-name}

    +
    update an existing pnf
    +

    PATCH /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    delete an existing pnf

    +

    update an existing pnf

    application/json application/xml

    +
    +
    +

    pnf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /pnf +
    +
    +
    @@ -76168,22 +87115,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -76215,19 +87146,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns lag-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

    +
    delete an existing pnf
    +

    DELETE /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    returns lag-interfaces

    +

    delete an existing pnf

    +
    + +

    application/json application/xml +

    +
    @@ -76258,10 +87194,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -76280,29 +87217,116 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /lag-interfaces -
    -
    -
    - -
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    + + + + + +
    +
    +
    returns lag-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

    + Tags: + Network +
    +
    +
    +

    returns lag-interfaces

    + +
    +
    +
    - orchestration-status + resource-version -

    orchestration-status is the status of orchestration on the PNF.

    +

    resource-version for concurrency

    		 query @@ -76269,6 +87205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    + pnf-name + +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + orchestration-status + +

    orchestration-status is the status of orchestration on the PNF.

    +     		query + string + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interfaces +
    +
    +
    + +
    default @@ -76423,7 +87447,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /lag-interface
    @@ -76470,7 +87494,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)

    @@ -76557,22 +87581,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing lag-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    update an existing lag-interface
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing lag-interface

    +

    update an existing lag-interface

    application/json application/xml

    +
    +
    +

    lag-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    @@ -76618,22 +87654,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -76665,19 +87685,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +
    delete an existing lag-interface
    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    returns l-interfaces

    +

    delete an existing lag-interface

    +
    + +

    application/json application/xml +

    +
    @@ -76724,10 +87749,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -76746,29 +87772,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -76791,17 +87794,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns l-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    returns l-interface

    +

    returns l-interfaces

    @@ -76848,22 +87851,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - orchestration-status + resource-version -

    orchestration-status is the status of orchestration on the PNF.

    +

    resource-version for concurrency

    		 query @@ -76735,6 +87760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    orchestration-status @@ -76879,51 +87866,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -76950,7 +87892,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l-interfaces
    @@ -76979,35 +87921,343 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    returns l-interface
    +

    GET /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

    +

    returns 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 + + + +
    + orchestration-status + +

    orchestration-status is the status of orchestration on the PNF.

    +     		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/v8/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 +
    +
    +
    +
    @@ -77444,7 +88694,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -77491,7 +88741,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -77610,22 +88860,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -77703,22 +88965,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -77750,35 +88996,176 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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 + + + +
    + 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/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -78232,7 +89619,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -78279,7 +89666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -78398,22 +89785,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -78491,22 +89890,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -78538,35 +89921,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -78644,6 +90015,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -78676,22 +90063,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -78800,35 +90199,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing 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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -79189,7 +90713,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /sriov-vfs
    @@ -79452,7 +90976,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /sriov-vf
    @@ -79499,7 +91023,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -79617,6 +91141,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing sriov-vf
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -79777,7 +91438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -80179,7 +91840,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /vlans
    @@ -80412,7 +92073,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /vlan
    @@ -80459,7 +92120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -80577,6 +92238,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing vlan
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -80984,7 +92782,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -81031,7 +92829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -81165,6 +92963,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -81341,7 +93292,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -81882,7 +93833,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -81929,7 +93880,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -82064,22 +94015,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -82173,22 +94136,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -82220,35 +94167,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -82342,6 +94277,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -82374,22 +94325,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -82514,35 +94477,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -82620,6 +94571,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -82652,22 +94619,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -82776,35 +94755,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -82850,73 +94817,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name -

    unique name of Physical Network Function.

    +

    Name given to the interface

    		 path @@ -82929,10 +94835,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -82974,19 +94880,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    returns p-interfaces

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -83017,17 +94940,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -83039,29 +94963,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interfaces -
    -
    -
    - -
    default @@ -83084,19 +94985,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    returns p-interface

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - orchestration-status + interface-name -

    orchestration-status is the status of orchestration on the PNF.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    @@ -83130,7 +95036,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -83141,21 +95047,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		query - string - - -
    @@ -83165,29 +95056,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interface -
    -
    -
    - -
    default @@ -83210,36 +95078,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing p-interface
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    returns p-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces

    Tags: Network
    -

    create or update an existing p-interface

    +

    returns p-interfaces

    -
    - -

    application/json application/xml -

    -
    -
    -

    p-interface object that needs to be created or updated

    -

    -
    -
    -
    -
    - /p-interface -
    -
    -
    -
    @@ -83270,18 +95121,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -83293,6 +95143,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /p-interfaces +
    +
    +
    + +
    default @@ -83316,23 +95189,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    delete an existing p-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    returns p-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    delete an existing p-interface

    +

    returns p-interface

    -
    - -

    application/json application/xml -

    -
    - interface-name + orchestration-status -

    Name that identifies the physical interface

    +

    orchestration-status is the status of orchestration on the PNF.

    		pathquery string -
    @@ -83379,10 +95247,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -83402,6 +95269,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /p-interface +
    +
    +
    + +
    default @@ -83424,19 +95314,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    create or update an existing p-interface
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    returns l-interfaces

    +

    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/v8/NetworkPnfsPnfPInterfacesPInterface.json)

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    +
    - resource-version + orchestration-status -

    resource-version for concurrency

    +

    orchestration-status is the status of orchestration on the PNF.

    		 query @@ -83390,7 +95258,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -83481,21 +95388,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		query - string - - -
    @@ -83505,29 +95397,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -83550,19 +95419,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    update an existing p-interface
    +

    PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    returns l-interface

    +

    update an existing p-interface

    +
    + +

    application/json application/xml +

    +
    +
    +

    p-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    +
    @@ -83607,82 +95493,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		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 - - -
    @@ -83692,29 +95502,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interface -
    -
    -
    - -
    default @@ -83737,35 +95524,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    delete an existing p-interface
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    create or update an existing l-interface

    +

    delete an existing p-interface

    application/json application/xml

    -
    -
    -

    l-interface object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l-interface -
    -
    -
    @@ -83813,12 +95588,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
    - interface-name + resource-version -

    Name given to the interface

    +

    resource-version for concurrency

    		pathquery string @@ -83858,24 +95633,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns l-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    delete an existing l-interface

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -83922,26 +95692,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - @@ -83961,6 +95714,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interfaces +
    +
    +
    + +
    default @@ -83983,17 +95759,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns l-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    returns l-interface

    @@ -84056,22 +95832,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - resource-version + orchestration-status -

    resource-version for concurrency

    +

    orchestration-status is the status of orchestration on the PNF.

    		 query @@ -83949,7 +95703,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    orchestration-status @@ -84132,51 +95892,6 @@ 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 - -

    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 - - -
    @@ -84203,7 +95918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l-interface
    @@ -84231,17 +95946,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/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 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 l3-interface-ipv4-address-list

    +

    create or update an existing l-interface

    @@ -84250,13 +95965,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

    - /l3-interface-ipv4-address-list + /l-interface
    @@ -84321,22 +96036,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -84368,23 +96067,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -84446,38 +96157,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -84509,35 +96188,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/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 l-interface
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -84601,12 +96268,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -84646,24 +96313,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -84740,6 +96402,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + orchestration-status + +

    orchestration-status is the status of orchestration on the PNF.

    +     		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 + + +
    @@ -84749,6 +96516,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -84771,19 +96561,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    @@ -84846,7 +96653,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -84860,109 +96667,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing l3-interface-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 +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - + - + - - - - - - - - + - + @@ -84974,29 +96813,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv6-address-list -
    -
    -
    - -
    default @@ -85019,35 +96835,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/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-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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + pnf-name -

    MAC address for the interface

    +

    unique name of Physical Network Function.

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name that identifies the physical interface

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id + interface-name -

    Neutron network id of the interface that address belongs to

    +

    Name given to the interface

    		querypath string +
    - neutron-subnet-id + l3-interface-ipv4-address -

    Neutron id of subnet that address belongs to

    +

    IP address

    		querypath string +
    @@ -85111,7 +96915,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -85125,6 +96929,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -85156,23 +96976,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -85236,7 +97068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -85250,22 +97082,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -85297,35 +97113,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/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
    +

    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -85389,7 +97193,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -85434,24 +97238,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns l3-interface-ipv6-address-list
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    delete an existing relationship

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -85528,6 +97327,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + orchestration-status + +

    orchestration-status is the status of orchestration on the PNF.

    +     		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 + + +
    @@ -85537,6 +97441,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -85559,17 +97486,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -85578,13 +97505,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /relationship + /l3-interface-ipv6-address-list
    @@ -85649,6 +97576,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -85680,23 +97623,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    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 +
    +
    +
    @@ -85758,6 +97713,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -85789,19 +97760,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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
    -

    returns sriov-vfs

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -85864,55 +97840,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -85931,29 +97879,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -85976,280 +97901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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

    - -
    -
    -
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + l3-interface-ipv6-address -

    MAC address for the interface

    +

    IP address

    		querypath string +
    - network-name + resource-version -

    Name of the network

    +

    resource-version for concurrency

    		 query @@ -85920,6 +97867,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 - - - -
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		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}

    +
    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
    -

    create or update an existing sriov-vf

    +

    see node definition for valid relationships

    @@ -86258,13 +97920,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /sriov-vf + /relationship
    @@ -86331,10 +97993,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -86376,17 +98038,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/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 sriov-vf

    +

    delete an existing relationship

    @@ -86456,10 +98118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -86470,22 +98132,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -86517,11 +98163,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -86536,7 +98182,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -86607,22 +98253,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -     		path - string - - - -
    @@ -86654,11 +98284,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -86732,22 +98362,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -     		path - string - - - -
    @@ -86779,17 +98393,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlans
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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 vlans

    +

    returns sriov-vfs

    @@ -86938,7 +98552,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /sriov-vfs
    @@ -86966,17 +98580,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlan
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    returns sriov-vf

    @@ -87041,10 +98655,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -87117,14 +98731,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + vf-vlan-filter -

    Inner VLAN tag

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query - integer + string @@ -87132,10 +98746,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vf-mac-filter -

    This indicates the customers VPN ID associated with this vlan

    +

    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 @@ -87171,7 +98815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /sriov-vf
    @@ -87199,17 +98843,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing sriov-vf
    +

    PUT /network/pnfs/pnf/{pnf-name}/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 vlan

    +

    create or update an existing sriov-vf

    @@ -87218,13 +98862,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /vlan + /sriov-vf
    @@ -87291,10 +98935,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -87336,23 +98980,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -87416,10 +99072,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -87430,22 +99086,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -87477,19 +99117,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    @@ -87552,26 +99197,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -87726,29 +99236,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -87771,17 +99258,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -87790,13 +99277,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l3-interface-ipv4-address-list + /relationship
    @@ -87863,26 +99350,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -87584,130 +99213,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - orchestration-status - -

    orchestration-status is the status of orchestration on the PNF.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -     		query - string - - -
    - neutron-subnet-id + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -87715,6 +99224,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -87924,17 +99395,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/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 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 l3-interface-ipv4-address-list

    +

    delete an existing relationship

    @@ -88004,26 +99475,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -88034,22 +99489,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -88081,36 +99520,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    returns vlans
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns vlans

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -88173,175 +99595,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    -
    - -
    -

    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 -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - + - + - + - + @@ -88353,6 +99662,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlans +
    +
    +
    + +
    default @@ -88375,17 +99707,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-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 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 l3-interface-ipv6-address-list

    +

    returns vlan

    @@ -88464,22 +99796,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + orchestration-status -

    Name that identifies the physical interface

    +

    orchestration-status is the status of orchestration on the PNF.

    		pathquery string -
    - interface-name + interface-id -

    Name given to the interface

    +

    ID of interface

    		pathquery string -
    - vlan-interface + macaddr -

    String that identifies the interface

    +

    MAC address for the interface

    		pathquery string -
    - l3-interface-ipv4-address + network-name -

    IP address

    +

    Name of the network

    		pathquery string -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    orchestration-status @@ -88570,51 +99886,6 @@ 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 - -

    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 - - -
    @@ -88641,7 +99912,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /vlan
    @@ -88669,17 +99940,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-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 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 l3-interface-ipv6-address-list

    +

    create or update an existing vlan

    @@ -88688,13 +99959,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

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /l3-interface-ipv6-address-list + /vlan
    @@ -88775,22 +100046,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -88822,23 +100077,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -88916,38 +100183,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -88979,35 +100214,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-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 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
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -89087,12 +100310,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -89132,24 +100355,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns l3-interface-ipv4-address-list
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -89228,7 +100446,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -89242,6 +100460,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + orchestration-status + +

    orchestration-status is the status of orchestration on the PNF.

    +     		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 + + +
    @@ -89251,6 +100604,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -89273,17 +100649,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -89292,13 +100668,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /relationship + /l3-interface-ipv4-address-list
    @@ -89379,6 +100755,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -89410,23 +100802,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -89504,6 +100908,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -89535,35 +100955,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -89609,73 +101017,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name -

    unique name of Physical Network Function.

    +

    Name given to the interface

    		 path @@ -89688,10 +101035,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name that identifies the physical interface

    +

    String that identifies the interface

    		 path @@ -89702,6 +101049,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -89733,11 +101112,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -89752,7 +101131,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -89791,6 +101170,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + 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 + + + +
    @@ -89822,11 +101265,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -89868,6 +101311,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + 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 + + + +
    @@ -89899,19 +101406,249 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns route-table-references
    -

    GET /network/route-table-references

    +
    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 route-table-references

    +

    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 + + + +
    + orchestration-status + +

    orchestration-status is the status of orchestration on the PNF.

    +     		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 @@ -89935,7 +101672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /route-table-references + /l3-interface-ipv6-address-list
    @@ -89963,19 +101700,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns route-table-reference
    -

    GET /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    create or update an existing l3-interface-ipv6-address-list
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    returns route-table-reference

    +

    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/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    @@ -89990,10 +101744,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + @@ -90028,29 +101831,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /route-table-reference -
    -
    -
    - -
    default @@ -90073,17 +101853,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing route-table-reference
    -

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    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
    -

    create or update an existing route-table-reference

    +

    update an existing l3-interface-ipv6-address-list

    @@ -90092,13 +101872,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    route-table-reference object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /route-table-reference + /l3-interface-ipv6-address-list
    @@ -90117,10 +101897,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    unique name of Physical Network Function.

    		 path @@ -90006,17 +101760,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-fqdn + interface-name -

    FQDN entry in the route table.

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string +
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -90162,17 +102006,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing route-table-reference
    -

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    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 route-table-reference

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -90194,10 +102038,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -90255,11 +102163,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -90274,7 +102182,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -90299,10 +102207,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -90344,11 +102316,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -90376,10 +102348,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -90421,48 +102457,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns site-pair-sets
    -

    GET /network/site-pair-sets

    +
    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
    -

    returns site-pair-sets

    +

    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/v8/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

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /site-pair-sets -
    -
    -
    - -
    default @@ -90485,19 +102594,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns site-pair-set
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    +
    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
    -

    returns site-pair-set

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -90512,10 +102626,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -91106,7 +103229,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /routing-instance + /route-table-reference
    @@ -91134,17 +103257,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 routing-instance

    +

    create or update an existing route-table-reference

    @@ -91153,13 +103276,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    routing-instance object that needs to be created or updated

    +

    route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)

    - /routing-instance + /route-table-reference
    @@ -91178,26 +103301,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    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 @@ -90535,29 +102697,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /site-pair-set -
    -
    -
    - -
    default @@ -90580,17 +102719,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing site-pair-set
    -

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing site-pair-set

    +

    see node definition for valid relationships

    @@ -90599,13 +102738,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    site-pair-set object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)

    - /site-pair-set + /relationship
    @@ -90624,10 +102763,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -90669,17 +102824,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing site-pair-set
    -

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    delete an existing site-pair-set

    +

    delete an existing relationship

    @@ -90701,10 +102856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -90717,12 +102872,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the physical interface

    		querypath string @@ -90762,11 +102917,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    Tags: Network
    @@ -90781,7 +102936,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)

    @@ -90806,10 +102961,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -90851,11 +103006,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    Tags: Network
    @@ -90883,10 +103038,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -90928,50 +103083,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns routing-instances
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

    +
    returns route-table-references
    +

    GET /network/route-table-references

    Tags: Network
    -

    returns routing-instances

    +

    returns route-table-references

    -
    - - - - - - - - - - - - - - - - - - - -
    - site-pair-set-id - -

    Unique id of site pair set.

    -     		path - string - - - -
    -

    application/json application/xml @@ -90995,7 +103119,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /routing-instances + /route-table-references
    @@ -91023,17 +103147,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns routing-instance
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

    +
    returns route-table-reference
    +

    GET /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    returns routing-instance

    +

    returns route-table-reference

    @@ -91050,10 +103174,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + route-table-reference-id -

    Unique id of site pair set.

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -91066,18 +103190,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + route-table-reference-fqdn -

    Unique id of routing instance

    +

    FQDN entry in the route table.

    		pathquery string -
    - site-pair-set-id - -

    Unique id of site pair set.

    -     		path - string - - - -
    - routing-instance-id + route-table-reference-id -

    Unique id of routing instance

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -91239,23 +103346,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing routing-instance
    -

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

    +
    update an existing route-table-reference
    +

    PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    delete an existing routing-instance

    +

    update an existing route-table-reference

    application/json application/xml

    +
    +
    +

    route-table-reference object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /route-table-reference +
    +
    +
    @@ -91271,10 +103390,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - site-pair-set-id + route-table-reference-id -

    Unique id of site pair set.

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -91285,12 +103404,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - routing-instance-id + route-table-reference-id -

    Unique id of routing instance

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -91348,11 +103528,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    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

    +

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    Tags: Network
    @@ -91367,7 +103547,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)

    @@ -91392,26 +103572,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id - -

    Unique id of site pair set.

    -     		path - string - - - -
    - routing-instance-id + route-table-reference-id -

    Unique id of routing instance

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -91453,11 +103617,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    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

    +

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    Tags: Network
    @@ -91485,26 +103649,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id - -

    Unique id of site pair set.

    -     		path - string - - - -
    - routing-instance-id + route-table-reference-id -

    Unique id of routing instance

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -91546,66 +103694,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns site-pairs
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

    +
    returns site-pair-sets
    +

    GET /network/site-pair-sets

    Tags: Network
    -

    returns site-pairs

    +

    returns site-pair-sets

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -91629,7 +103730,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /site-pairs + /site-pair-sets
    @@ -91657,17 +103758,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    returns site-pair-set
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    returns site-pair

    +

    returns site-pair-set

    @@ -91698,38 +103799,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id - -

    Unique id of routing instance

    -     		path - string - - - -
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    @@ -91756,7 +103825,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /site-pair + /site-pair-set
    @@ -91784,17 +103853,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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

    +

    create or update an existing site-pair-set

    @@ -91803,13 +103872,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    site-pair object that needs to be created or updated

    +

    site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)

    - /site-pair + /site-pair-set
    @@ -91842,38 +103911,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id - -

    Unique id of routing instance

    -     		path - string - - - -
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    @@ -91905,23 +103942,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    update an existing site-pair-set
    +

    PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    delete an existing site-pair

    +

    update an existing site-pair-set

    application/json application/xml

    +
    +
    +

    site-pair-set object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /site-pair-set +
    +
    +
    @@ -91951,28 +104000,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - -
    - routing-instance-id - -

    Unique id of routing instance

    -     		path - string - - - -
    - site-pair-id + site-pair-set-id -

    unique identifier of probe

    +

    Unique id of site pair set.

    		 path @@ -92030,19 +104124,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    see node definition for valid relationships
    +

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    Tags: Network
    -

    returns classes-of-service

    +

    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/v8/NetworkSitePairSetsSitePairSet.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -92071,12 +104182,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - routing-instance-id + site-pair-set-id -

    Unique id of routing instance

    +

    Unique id of site pair set.

    		 path @@ -92087,12 +104259,68 @@ 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 routing-instances
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

    + Tags: + Network +
    +
    +
    +

    returns routing-instances

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - -
    - site-pair-id + site-pair-set-id -

    unique identifier of probe

    +

    Unique id of site pair set.

    		 path @@ -92129,7 +104357,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /classes-of-service + /routing-instances
    @@ -92157,17 +104385,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 class-of-service

    +

    returns routing-instance

    @@ -92214,38 +104442,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    - cos - -

    unique identifier of probe

    -     		path - string - - - -
    @@ -92272,7 +104468,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /class-of-service + /routing-instance
    @@ -92300,17 +104496,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 class-of-service

    +

    create or update an existing routing-instance

    @@ -92319,13 +104515,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    class-of-service object that needs to be created or updated

    +

    routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

    - /class-of-service + /routing-instance
    @@ -92374,38 +104570,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    - cos - -

    unique identifier of probe

    -     		path - string - - - -
    @@ -92437,23 +104601,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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
    -

    delete an existing class-of-service

    +

    update an existing routing-instance

    application/json application/xml

    +
    +
    +

    routing-instance object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /routing-instance +
    +
    +
    @@ -92499,54 +104675,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    - cos - -

    unique identifier of probe

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -92578,35 +104706,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing routing-instance

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -92654,28 +104770,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -93321,7 +105223,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vce + /site-pair
    @@ -93349,17 +105251,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vce
    -

    PUT /network/vces/vce/{vnf-id}

    +
    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 vce

    +

    create or update an existing site-pair

    @@ -93368,13 +105270,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vce object that needs to be created or updated

    +

    site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

    - /vce + /site-pair
    @@ -93393,10 +105295,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + +
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    - cos + resource-version -

    unique identifier of probe

    +

    resource-version for concurrency

    		pathquery string @@ -92715,23 +104815,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -92777,38 +104889,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    - cos - -

    unique identifier of probe

    -     		path - string - - - -
    @@ -92840,35 +104920,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -92914,22 +104982,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - site-pair-id - -

    unique identifier of probe

    -     		path - string - - - -
    @@ -92961,24 +105013,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    delete an existing relationship

    +

    returns site-pairs

    -
    - -

    application/json application/xml -

    -
    @@ -93023,67 +105070,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - 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

    @@ -93106,7 +105096,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vces + /site-pairs
    @@ -93134,17 +105124,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vce
    -

    GET /network/vces/vce/{vnf-id}

    +
    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 vce

    +

    returns site-pair

    @@ -93161,10 +105151,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -93177,122 +105167,34 @@ 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. Expect this to change as ASDC matures.

    -     		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 + routing-instance-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique id of routing instance

    		querypath string +
    - vpe-id + site-pair-id -

    Unique ID of VPE connected to this VCE.

    +

    unique identifier of probe

    		querypath string +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    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 @@ -93438,23 +105372,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vce
    -

    DELETE /network/vces/vce/{vnf-id}

    +
    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
    -

    delete an existing vce

    +

    update an existing site-pair

    application/json application/xml

    +
    +
    +

    site-pair object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /site-pair +
    +
    +
    @@ -93470,10 +105416,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -93486,12 +105432,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + routing-instance-id -

    resource-version for concurrency

    +

    Unique id of routing instance

    		querypath + string + + + +
    + site-pair-id + +

    unique identifier of probe

    +     		path string @@ -93531,19 +105493,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns port-groups
    -

    GET /network/vces/vce/{vnf-id}/port-groups

    +
    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
    -

    returns port-groups

    +

    delete an existing site-pair

    +
    + +

    application/json application/xml +

    +
    @@ -93558,10 +105525,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + - + + +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -93574,70 +105541,42 @@ 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 + routing-instance-id -

    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.

    +

    Unique id of routing instance

    		querypath string +
    - service-id + site-pair-id -

    Unique identifier of service from ASDC. Expect this to change as ASDC matures.

    +

    unique identifier of probe

    		querypath string +
    - regional-resource-zone + resource-version -

    Regional way of organizing pservers, source of truth should define values

    +

    resource-version for concurrency

    		 query @@ -93645,51 +105584,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns 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

    + +
    +
    + + + + + + + + + + + - + - + - + @@ -93718,7 +105717,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /port-groups + /classes-of-service
    @@ -93746,17 +105745,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns port-group
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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 port-group

    +

    returns class-of-service

    @@ -93773,10 +105772,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -93994,7 +105860,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /port-group + /class-of-service
    @@ -94022,17 +105888,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing port-group
    -

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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 port-group

    +

    create or update an existing class-of-service

    @@ -94041,13 +105907,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    port-group object that needs to be created or updated

    +

    class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

    - /port-group + /class-of-service
    @@ -94066,10 +105932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + - + - + @@ -97255,7 +109824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status + + + + + + + - - - - - - - - - - - - - -
    - prov-status + site-pair-set-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id of site pair set.

    		querypath string +
    - heat-stack-id + routing-instance-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique id of routing instance

    		querypath string +
    - vpe-id + site-pair-id -

    Unique ID of VPE connected to this VCE.

    +

    unique identifier of probe

    		querypath string +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -93789,10 +105788,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    		 path @@ -93805,167 +105804,34 @@ 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. Expect this to change as ASDC matures.

    -     		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 + site-pair-id -

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    +

    unique identifier of probe

    		querypath string +
    - heat-stack-id + cos -

    Heat stack id corresponding to this instance, managed by MSO

    +

    unique identifier of probe

    		querypath string +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -94082,10 +105948,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    +     		path + string + + + +
    + site-pair-id + +

    unique identifier of probe

    +     		path + string + + + +
    + cos + +

    unique identifier of probe

    		 path @@ -94127,23 +106025,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing port-group
    -

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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
    -

    delete an existing port-group

    +

    update an existing class-of-service

    application/json application/xml

    +
    +
    +

    class-of-service object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /class-of-service +
    +
    +
    @@ -94159,10 +106069,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + - - - - - - -
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -94175,10 +106085,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    		 path @@ -94191,12 +106101,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + site-pair-id -

    resource-version for concurrency

    +

    unique identifier of probe

    		querypath + string + + + +
    + cos + +

    unique identifier of probe

    +     		path string @@ -94236,19 +106162,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns cvlan-tags
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

    +
    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
    -

    returns cvlan-tags

    +

    delete an existing class-of-service

    +
    + +

    application/json application/xml +

    +
    @@ -94263,10 +106194,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -94279,10 +106210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    		 path @@ -94295,100 +106226,42 @@ 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. Expect this to change as ASDC matures.

    -     		query - string - - -
    - regional-resource-zone + site-pair-id -

    Regional way of organizing pservers, source of truth should define values

    +

    unique identifier of probe

    		querypath string +
    - prov-status + cos -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    unique identifier of probe

    		querypath string +
    - heat-stack-id + resource-version -

    Heat stack id corresponding to this instance, managed by MSO

    +

    resource-version for concurrency

    		 query @@ -94396,66 +106269,144 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + @@ -94467,29 +106418,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /cvlan-tags -
    -
    -
    - -
    default @@ -94512,19 +106440,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns cvlan-tag-entry
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

    +
    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
    -

    returns cvlan-tag-entry

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - vpe-id + site-pair-set-id -

    Unique ID of VPE connected to this VCE.

    +

    Unique id of site pair set.

    		querypath string +
    - port-group-id + routing-instance-id -

    Unique ID for port group in vmware

    +

    Unique id of routing instance

    		querypath string +
    - switch-name + site-pair-id -

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    +

    unique identifier of probe

    		querypath string +
    - heat-stack-id + cos -

    Heat stack id corresponding to this instance, managed by MSO

    +

    unique identifier of probe

    		querypath string +
    @@ -94539,10 +106472,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -94759,29 +106543,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /cvlan-tag-entry -
    -
    -
    - -
    default @@ -94804,17 +106565,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    create or update an existing cvlan-tag-entry

    +

    see node definition for valid relationships

    @@ -94823,13 +106584,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cvlan-tag-entry object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

    - /cvlan-tag-entry + /relationship
    @@ -94848,10 +106609,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -94555,10 +106488,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    		 path @@ -94571,14 +106504,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + site-pair-id -

    See mis-na-virtualization-platform.yang

    +

    unique identifier of probe

    		 path - integer + string @@ -94587,167 +106520,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + cos -

    Name of VNF.

    +

    unique identifier of probe

    		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. Expect this to change as ASDC matures.

    -     		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

    -     		querypath string +
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -94864,10 +106625,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    		 path @@ -94880,14 +106641,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + site-pair-id -

    See mis-na-virtualization-platform.yang

    +

    unique identifier of probe

    		 path - integer + string @@ -94925,17 +106686,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 cvlan-tag-entry

    +

    delete an existing relationship

    @@ -94957,10 +106718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + site-pair-set-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique id of site pair set.

    		 path @@ -94973,10 +106734,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + routing-instance-id -

    Unique ID of the interface

    +

    Unique id of routing instance

    		 path @@ -94989,28 +106750,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + site-pair-id -

    See mis-na-virtualization-platform.yang

    +

    unique identifier of probe

    		 path - integer - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query string @@ -95050,105 +106795,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    returns vces
    +

    GET /network/vces

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns vces

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vces +
    +
    +
    + +
    default @@ -95171,24 +106859,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    returns vce
    +

    GET /network/vces/vce/{vnf-id}

    Tags: Network
    -

    delete an existing relationship

    +

    returns vce

    -
    - -

    application/json application/xml -

    -
    @@ -95219,34 +106902,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -95258,6 +107029,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vce +
    +
    +
    + +
    default @@ -95280,17 +107074,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    +
    create or update an existing vce
    +

    PUT /network/vces/vce/{vnf-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing vce

    @@ -95299,13 +107093,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

    +

    vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)

    - /relationship + /vce
    @@ -95338,22 +107132,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - -
    - interface-id + vnf-name -

    Unique ID of the interface

    +

    Name of VNF.

    		pathquery string -
    - cvlan-tag + vnf-name2 -

    See mis-na-virtualization-platform.yang

    +

    Alternate name of VNF.

    		pathquery - integer + 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. Expect this to change as ASDC matures.

    +     		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 -
    - interface-id - -

    Unique ID of the interface

    -     		path - string - - - -
    @@ -95385,23 +107163,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    +
    update an existing vce
    +

    PATCH /network/vces/vce/{vnf-id}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing vce

    application/json application/xml

    +
    +
    +

    vce object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vce +
    +
    +
    @@ -95431,22 +107221,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - interface-id - -

    Unique ID of the interface

    -     		path - string - - - -
    @@ -95478,35 +107252,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

    +
    delete an existing vce
    +

    DELETE /network/vces/vce/{vnf-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vce

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -95536,6 +107298,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -95567,24 +107345,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

    +
    returns port-groups
    +

    GET /network/vces/vce/{vnf-id}/port-groups

    Tags: Network
    -

    delete an existing relationship

    +

    returns port-groups

    -
    - -

    application/json application/xml -

    -
    @@ -95613,51 +107386,130 @@ 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. Expect this to change as ASDC matures.

    +     		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 -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns vnfcs
    -

    GET /network/vnfcs

    - Tags: - Network -
    -
    -
    -

    returns vnfcs

    - -
    -

    application/json application/xml

    @@ -95680,7 +107532,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnfcs + /port-groups
    @@ -95708,17 +107560,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vnfc
    -

    GET /network/vnfcs/vnfc/{vnfc-name}

    +
    returns port-group
    +

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    returns vnfc

    +

    returns port-group

    @@ -95735,10 +107587,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + vnf-id -

    Unique ID of vnfc.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -95751,10 +107603,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-function-code + interface-id -

    function code

    +

    Unique ID of the interface

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -95766,10 +107634,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-type + vnf-name2 -

    type

    +

    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. Expect this to change as ASDC matures.

    +     		query + string + + +
    + regional-resource-zone + +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -95784,7 +107697,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

    prov status of this vnfc

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -95796,10 +107709,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipaddress-v4-oam-vip + heat-stack-id -

    Oam V4 vip address of this vnfc

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -95811,13 +107724,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + vpe-id +

    Unique ID of VPE connected to this VCE.

    		 query - boolean + string @@ -95825,13 +107739,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + port-group-id +

    Unique ID for port group in vmware

    		 query - boolean + string @@ -95839,10 +107754,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-notation + switch-name -

    Group notation of VNFC

    +

    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 @@ -95878,7 +107808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnfc + /port-group
    @@ -95906,17 +107836,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vnfc
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}

    +
    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 vnfc

    +

    create or update an existing port-group

    @@ -95925,13 +107855,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vnfc object that needs to be created or updated

    +

    port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)

    - /vnfc + /port-group
    @@ -95950,10 +107880,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + vnf-id -

    Unique ID of vnfc.

    +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-id + +

    Unique ID of the interface

    		 path @@ -95995,23 +107941,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vnfc
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}

    +
    update an existing port-group
    +

    PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    delete an existing vnfc

    +

    update an existing port-group

    application/json application/xml

    +
    +
    +

    port-group object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /port-group +
    +
    +
    @@ -96027,10 +107985,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnfc-name + vnf-id -

    Unique ID of vnfc.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96043,12 +108001,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-id -

    resource-version for concurrency

    +

    Unique ID of the interface

    		querypath string @@ -96088,35 +108046,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    +
    delete an existing port-group
    +

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing port-group

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -96132,10 +108078,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - vnfc-name + vnf-id -

    Unique ID of vnfc.

    +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-id + +

    Unique ID of the interface

    		 path @@ -96146,6 +108108,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -96177,24 +108155,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    +
    returns cvlan-tags
    +

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

    Tags: Network
    -

    delete an existing relationship

    +

    returns cvlan-tags

    -
    - -

    application/json application/xml -

    -
    @@ -96209,10 +108182,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnfc-name + vnf-id -

    Unique ID of vnfc.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96223,50 +108196,190 @@ 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.

    - -
    -
    -
    - -
    -
    - -
    -
    +
    + 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 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. Expect this to change as ASDC matures.

    +     		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 + + +
    -
    -
    - - -
    -
    -
    returns vpls-pes
    -

    GET /network/vpls-pes

    - Tags: - Network -
    -
    -
    -

    returns vpls-pes

    - -

    application/json application/xml @@ -96290,7 +108403,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /vpls-pes + /cvlan-tags
    @@ -96318,17 +108431,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 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 vpls-pe

    +

    returns cvlan-tag-entry

    @@ -96345,9 +108458,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-id + +

    Unique ID of the interface

    		 path @@ -96358,12 +108488,178 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 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. Expect this to change as ASDC matures.

    +     		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 VNF by BAU Service Assurance systems.

    +

    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 @@ -96399,7 +108695,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vpls-pe + /cvlan-tag-entry
    @@ -96427,17 +108723,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 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 vpls-pe

    +

    create or update an existing cvlan-tag-entry

    @@ -96446,13 +108742,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

    +

    cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

    - /vpls-pe + /cvlan-tag-entry
    @@ -96471,9 +108767,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id + +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-id +

    Unique ID of the interface

    		 path @@ -96484,6 +108797,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    @@ -96515,23 +108844,35 @@ 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}

    +
    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
    -

    delete an existing vpls-pe

    +

    update an existing cvlan-tag-entry

    application/json application/xml

    +
    +
    +

    cvlan-tag-entry object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /cvlan-tag-entry +
    +
    +
    @@ -96547,9 +108888,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96562,12 +108904,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-id -

    resource-version for concurrency

    +

    Unique ID of the interface

    		querypath string @@ -96576,6 +108918,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    @@ -96607,19 +108965,24 @@ 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

    +
    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
    -

    returns lag-interfaces

    +

    delete an existing cvlan-tag-entry

    +
    + +

    application/json application/xml +

    +
    @@ -96634,9 +108997,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -96671,29 +109068,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /lag-interfaces -
    -
    -
    - -
    default @@ -96716,19 +109090,36 @@ 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}

    +
    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
    -

    returns lag-interface

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96649,10 +109013,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique ID of the interface

    +     		path + string + + + +
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -96660,6 +109056,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -96743,9 +109134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -96796,29 +109189,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK +
    + default
    -
    +
    -

    successful operation

    +

    Response codes found in response codes.

    - +
    -
    - -
    - /lag-interface -
    -
    -
    - +
    +
    +
    + + + + + +
    +
    +
    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 +

    +
    +
    +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96758,10 +109150,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the link aggregate interface

    +

    Unique ID of the interface

    		 path @@ -96774,17 +109166,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + cvlan-tag -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    See mis-na-virtualization-platform.yang

    		querypath - string + integer +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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 @@ -96841,17 +109320,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}

    +
    see node definition for valid relationships
    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing lag-interface

    +

    see node definition for valid relationships

    @@ -96860,13 +109339,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    lag-interface object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)

    - /lag-interface + /relationship
    @@ -96885,9 +109364,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96900,10 +109380,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the link aggregate interface

    +

    Unique ID of the interface

    		 path @@ -96945,17 +109425,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing lag-interface
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    +
    delete an existing relationship
    +

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing lag-interface

    +

    delete an existing relationship

    @@ -96977,9 +109457,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -96992,10 +109473,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the link aggregate interface

    +

    Unique ID of the interface

    		 path @@ -97006,22 +109487,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -97053,19 +109518,36 @@ 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

    +
    see node definition for valid relationships
    +

    PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

    Tags: Network
    -

    returns l-interfaces

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -97080,9 +109562,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -97093,12 +109576,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - -
    - interface-name + vnf-id -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -97109,25 +109653,51 @@ 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 - - -
    +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns vnfcs
    +

    GET /network/vnfcs

    + Tags: + Network +
    +
    +
    +

    returns vnfcs

    + +
    +

    application/json application/xml

    @@ -97150,7 +109720,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /vnfcs
    @@ -97178,17 +109748,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 vnfc
    +

    GET /network/vnfcs/vnfc/{vnfc-name}

    Tags: Network
    -

    returns l-interface

    +

    returns vnfc

    @@ -97205,9 +109775,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnfc-name +

    Unique ID of vnfc.

    		 path @@ -97220,34 +109791,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnfc-function-code -

    Name that identifies the link aggregate interface

    +

    function code

    		pathquery string -
    - interface-name + vnfc-type -

    Name given to the interface

    +

    type

    		pathquery string -
    -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    prov status of this vnfc

    		 query @@ -97267,10 +109836,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + ipaddress-v4-oam-vip -

    ID of interface

    +

    Oam V4 vip address of this vnfc

    		 query @@ -97282,14 +109851,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + in-maint -

    MAC address for the interface

    		 query - string + boolean @@ -97297,10 +109865,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + is-closed-loop-disabled -

    Name of the network

    +     		query + boolean + + +
    + group-notation + +

    Group notation of VNFC

    		 query @@ -97336,7 +109918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /vnfc
    @@ -97364,17 +109946,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 vnfc
    +

    PUT /network/vnfcs/vnfc/{vnfc-name}

    Tags: Network
    -

    create or update an existing l-interface

    +

    create or update an existing vnfc

    @@ -97383,13 +109965,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

    +

    vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)

    - /l-interface + /vnfc
    @@ -97408,41 +109990,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnfc-name -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    +

    Unique ID of vnfc.

    		 path @@ -97484,23 +110035,35 @@ 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}

    +
    update an existing vnfc
    +

    PATCH /network/vnfcs/vnfc/{vnfc-name}

    Tags: Network
    -

    delete an existing l-interface

    +

    update an existing vnfc

    application/json application/xml

    +
    +
    +

    vnfc object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vnfc +
    +
    +
    @@ -97516,25 +110079,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - equipment-name - - path - string - - - -
    - interface-name + vnfc-name -

    Name that identifies the link aggregate interface

    +

    Unique ID of vnfc.

    		 path @@ -97545,12 +110093,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing vnfc
    +

    DELETE /network/vnfcs/vnfc/{vnfc-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing vnfc

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + vnfc-name -

    Name given to the interface

    +

    Unique ID of vnfc.

    		 path @@ -97608,19 +110217,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -97635,25 +110261,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - equipment-name - - path - string - - - -
    - interface-name + vnfc-name -

    Name that identifies the link aggregate interface

    +

    Unique ID of vnfc.

    		 path @@ -97664,12 +110275,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + vnfc-name -

    Name given to the interface

    +

    Unique ID of vnfc.

    		 path @@ -97680,12 +110352,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns vpls-pes
    +

    GET /network/vpls-pes

    + Tags: + Network +
    +
    +
    +

    returns vpls-pes

    + +
    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vpls-pes +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns vpls-pe
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}

    + Tags: + Network +
    +
    +
    +

    returns vpls-pe

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv4-address + equipment-name -

    IP address

    		 path @@ -97711,96 +110502,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -97827,7 +110528,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /vpls-pe
    @@ -97855,17 +110556,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 vpls-pe
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    create or update an existing vpls-pe

    @@ -97874,13 +110575,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

    +

    vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)

    - /l3-interface-ipv4-address-list + /vpls-pe
    @@ -97912,12 +110613,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 +
    +
    +
    +
    +
    + + + + + + + + + + + + +
    - interface-name + equipment-name -

    Name that identifies the link aggregate interface

    		 path @@ -97928,12 +110701,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing vpls-pe
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing vpls-pe

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + - - - - - - -
    - interface-name + equipment-name -

    Name given to the interface

    		 path @@ -97946,12 +110779,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -97991,24 +110824,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns lag-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    returns lag-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -98038,26 +110866,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - interface-name + prov-status -

    Name that identifies the link aggregate interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery 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

    + +
    +
    + + + + + + + + + + + @@ -98109,6 +111013,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interface +
    +
    +
    + +
    default @@ -98131,17 +111058,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    create or update an existing lag-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing lag-interface

    @@ -98150,13 +111077,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

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

    - /relationship + /lag-interface
    @@ -98204,12 +111131,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - interface-name + equipment-name -

    Name given to the interface

    		 path @@ -98070,10 +110975,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 that identifies the link aggregate interface

    		 path @@ -98086,10 +110991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + prov-status -

    resource-version for concurrency

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -98097,7 +111002,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - + - + + +
    - interface-name + equipment-name -

    Name given to the interface

    		 path @@ -98222,10 +111221,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 that identifies the link aggregate interface

    		 path @@ -98267,17 +111266,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing lag-interface
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing lag-interface

    @@ -98330,28 +111329,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -98391,17 +111374,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns l-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns l-interfaces

    @@ -98449,26 +111432,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + prov-status -

    Name given to the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery 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

    + +
    +
    + + + + + + + + + + + - + - + - - - - - - - - - - - - - -
    - l3-interface-ipv6-address + equipment-name -

    IP address

    		 path @@ -98481,40 +111541,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -98526,10 +111588,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-id -

    Name of the network

    +

    ID of interface

    		 query @@ -98541,25 +111603,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 + macaddr -

    Neutron network id of the interface that address belongs to

    +

    MAC address for the interface

    		 query @@ -98571,10 +111618,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + network-name -

    Neutron id of subnet that address belongs to

    +

    Name of the network

    		 query @@ -98610,7 +111657,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l-interface
    @@ -98638,17 +111685,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    create or update an existing l-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    create or update an existing l-interface

    @@ -98657,13 +111704,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

    - /l3-interface-ipv6-address-list + /l-interface
    @@ -98727,22 +111774,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -98774,23 +111805,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    update an existing l-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -98851,38 +111894,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -98914,35 +111925,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -99005,12 +112004,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -99050,24 +112049,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 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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -99129,7 +112123,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -99143,6 +112137,111 @@ 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 + +

    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 + + +
    @@ -99152,6 +112251,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -99174,17 +112296,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 l3-interface-ipv4-address-list
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -99193,13 +112315,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /relationship + /l3-interface-ipv4-address-list
    @@ -99263,6 +112385,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -99294,23 +112432,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -99371,6 +112521,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -99402,19 +112568,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    delete an existing 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
    -

    returns sriov-vfs

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -99476,25 +112647,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    IP address

    		querypath string +
    - interface-id + resource-version -

    ID of interface

    +

    resource-version for concurrency

    		 query @@ -99502,36 +112674,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -99543,29 +112822,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK +
    + default
    -
    +
    -

    successful operation

    +

    Response codes found in response codes.

    - +
    -
    - -
    - /sriov-vfs -
    -
    -
    - +
    +
    +
    + + + + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +
    - macaddr + equipment-name -

    MAC address for the interface

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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 @@ -99588,17 +112968,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 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 sriov-vf

    +

    returns l3-interface-ipv6-address-list

    @@ -99662,10 +113042,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -99738,14 +113118,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-filter + vlan-id-inner -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Inner VLAN tag

    		 query - string + integer @@ -99753,10 +113133,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + neutron-network-id -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -99768,25 +113148,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 + neutron-subnet-id -

    Neutron network id of the interface

    +

    Neutron id of subnet that address belongs to

    		 query @@ -99822,7 +113187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -99850,17 +113215,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 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 sriov-vf

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -99869,13 +113234,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -99941,10 +113306,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -99986,23 +113351,35 @@ 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}

    +
    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
    -

    delete an existing sriov-vf

    +

    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 +
    +
    +
    @@ -100065,10 +113442,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -100079,22 +113456,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -100126,35 +113487,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -100217,10 +113566,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -100231,6 +113580,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -100262,23 +113627,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -100341,10 +113718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -100386,19 +113763,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -100460,62 +113842,138 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - prov-status + l3-interface-ipv6-address -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    IP address

    		querypath 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/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + @@ -100527,29 +113985,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -100572,19 +114007,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    returns vlan

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - interface-id + equipment-name -

    ID of interface

    		querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name given to the interface

    		querypath string +
    @@ -100644,12 +114084,67 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns 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

    + +
    +
    + + + + + + + + + + + - + - + + + + + + + + + + + + + + +
    - vlan-interface + equipment-name -

    String that identifies the interface

    		 path @@ -100662,40 +114157,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -100707,10 +114204,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-id -

    Name of the network

    +

    ID of interface

    		 query @@ -100722,14 +114219,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + macaddr -

    Inner VLAN tag

    +

    MAC address for the interface

    		 query - integer + string @@ -100737,10 +114234,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + network-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name of the network

    		 query @@ -100776,7 +114273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /sriov-vfs
    @@ -100804,36 +114301,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    create or update an existing vlan

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    vlan object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vlan -
    -
    -
    -
    @@ -100895,10 +114375,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -100909,6 +114389,126 @@ 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 + +

    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 + + +
    @@ -100918,6 +114518,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -100940,23 +114563,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    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/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -101019,10 +114654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -101033,22 +114668,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -101080,19 +114699,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    update an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    @@ -101154,26 +114790,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -101184,141 +114804,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - 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 - - -
    @@ -101328,29 +114813,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -101373,35 +114835,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    @@ -101464,10 +114914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -101480,12 +114930,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -101525,23 +114975,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -101604,26 +115066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -101634,22 +115080,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -101681,35 +115111,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -101772,26 +115190,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -101833,24 +115235,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns vlans

    -
    - -

    application/json application/xml -

    -
    @@ -101912,34 +115309,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + @@ -101951,6 +115376,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlans +
    +
    +
    + +
    default @@ -101973,17 +115421,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    returns vlan

    @@ -102061,22 +115509,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv4-address + interface-id -

    IP address

    +

    ID of interface

    		pathquery + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query string -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    prov-status @@ -102167,51 +115599,6 @@ 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 - -

    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 - - -
    @@ -102238,7 +115625,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /vlan
    @@ -102266,17 +115653,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    create or update an existing vlan

    @@ -102285,13 +115672,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

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /l3-interface-ipv6-address-list + /vlan
    @@ -102371,22 +115758,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -102418,23 +115789,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -102511,38 +115894,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -102574,35 +115925,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -102681,12 +116020,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -102726,24 +116065,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -102821,7 +116155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -102835,6 +116169,141 @@ 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 + +

    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 + + +
    @@ -102844,6 +116313,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv4-address-list +
    +
    +
    + +
    default @@ -102866,17 +116358,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -102885,13 +116377,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /relationship + /l3-interface-ipv4-address-list
    @@ -102971,6 +116463,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -103002,23 +116510,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -103095,6 +116615,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    @@ -103126,35 +116662,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -103199,72 +116723,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name +

    Name given to the interface

    		 path @@ -103277,10 +116741,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -103291,67 +116755,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns p-interfaces
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

    - Tags: - Network -
    -
    -
    -

    returns p-interfaces

    - -
    -
    - - - - - - - - - - - @@ -103386,29 +116796,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interfaces -
    -
    -
    - -
    default @@ -103431,19 +116818,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interface
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    returns p-interface

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - equipment-name + l3-interface-ipv4-address +

    IP address

    		 path @@ -103364,10 +116773,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + resource-version -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    resource-version for concurrency

    		 query @@ -103375,6 +116784,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -103476,7 +116880,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -103489,120 +116893,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name given to the interface

    		querypath 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 + vlan-interface +

    String that identifies the interface

    		 path @@ -103615,10 +116925,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name that identifies the physical interface

    +

    IP address

    		 path @@ -103660,17 +116970,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing p-interface
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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 p-interface

    +

    delete an existing relationship

    @@ -103710,7 +117020,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -103723,12 +117033,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -103737,67 +117047,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + vlan-interface +

    String that identifies the interface

    		 path @@ -103810,10 +117065,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name that identifies the physical interface

    +

    IP address

    		 path @@ -103824,21 +117079,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    @@ -103848,29 +117088,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -103893,17 +117110,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    returns l3-interface-ipv6-address-list

    @@ -103938,7 +117155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -103965,6 +117182,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    prov-status @@ -104025,6 +117274,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    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 + + +
    @@ -104051,7 +117375,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l3-interface-ipv6-address-list
    @@ -104079,17 +117403,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -104098,13 +117422,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /l-interface + /l3-interface-ipv6-address-list
    @@ -104141,7 +117465,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -104168,6 +117492,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -104199,23 +117555,35 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    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 +
    +
    +
    @@ -104249,7 +117617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -104278,12 +117646,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -104323,19 +117707,24 @@ 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}/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-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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -104368,7 +117757,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -104525,29 +117841,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -104570,17 +117863,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -104589,13 +117882,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /relationship
    @@ -104632,7 +117925,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    + + + + + + + - + - - - - - - - - +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -104397,10 +117786,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 @@ -104413,100 +117802,26 @@ 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 - -

    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 + l3-interface-ipv6-address -

    Neutron network id of the interface that address belongs to

    +

    IP address

    		querypath string +
    - neutron-subnet-id + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -104514,6 +117829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -104661,7 +117954,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address

    IP address

    @@ -104706,17 +118015,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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 l3-interface-ipv4-address-list

    +

    delete an existing relationship

    @@ -104756,7 +118065,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -104785,10 +118094,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 @@ -104801,12 +118110,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -104846,11 +118155,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/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 /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
    @@ -104865,7 +118174,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    @@ -104908,7 +118217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -104937,10 +118246,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 @@ -104982,11 +118291,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/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 /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
    @@ -105032,7 +118341,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -105061,10 +118370,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 @@ -105106,19 +118415,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -105151,7 +118477,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -105162,12 +118488,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + equipment-name -

    Name given to the interface

    		 path @@ -105180,10 +118566,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 that identifies the link aggregate interface

    		 path @@ -105194,102 +118580,83 @@ 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 p-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

    + Tags: + Network +
    +
    +
    +

    returns p-interfaces

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - -
    - 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 + equipment-name -

    Neutron network id of the interface that address belongs to

    		querypath string +
    - neutron-subnet-id + prov-status -

    Neutron id of subnet that address belongs to

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -105325,7 +118692,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /p-interfaces
    @@ -105353,36 +118720,19 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns p-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns p-interface

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -105428,34 +118778,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - @@ -105467,6 +118800,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /p-interface +
    +
    +
    + +
    default @@ -105489,23 +118845,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 p-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    - interface-name + prov-status -

    Name given to the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - -
    @@ -105550,54 +118918,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -105629,17 +118949,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing p-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing p-interface

    @@ -105648,13 +118968,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

    +

    p-interface object that needs to be created or updated.

    - /relationship + /p-interface
    @@ -105702,38 +119022,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -105765,17 +119053,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing p-interface
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing p-interface

    @@ -105828,28 +119116,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -105889,36 +119161,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -105964,18 +119219,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -105987,6 +119241,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interfaces +
    +
    +
    + +
    default @@ -106009,24 +119286,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l-interface

    -
    - -

    application/json application/xml -

    -
    - interface-name + prov-status -

    Name given to the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    @@ -106086,6 +119358,66 @@ 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 + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    @@ -106095,6 +119427,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interface +
    +
    +
    + +
    default @@ -106117,19 +119472,36 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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
    -

    returns sriov-vfs

    +

    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/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    +
    @@ -106189,57 +119561,240 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing l-interface
    +

    PATCH /network/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 +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + + +
    - prov-status + equipment-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name that identifies the physical interface

    		querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name given to the interface

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing l-interface
    +

    DELETE /network/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 +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -106258,29 +119814,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -106303,17 +119836,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    returns l3-interface-ipv4-address-list

    @@ -106377,10 +119910,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - network-name + equipment-name -

    Name of the network

    +     		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 @@ -106247,6 +119802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - pci-id + l3-interface-ipv4-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -106453,14 +119986,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-filter + vlan-id-inner -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Inner VLAN tag

    		 query - string + integer @@ -106468,10 +120001,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + neutron-network-id -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -106483,25 +120016,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 + neutron-subnet-id -

    Neutron network id of the interface

    +

    Neutron id of subnet that address belongs to

    		 query @@ -106537,7 +120055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /l3-interface-ipv4-address-list
    @@ -106565,17 +120083,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -106584,13 +120102,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /sriov-vf + /l3-interface-ipv4-address-list
    @@ -106656,10 +120174,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv4-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -106701,23 +120219,35 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    delete an existing sriov-vf

    +

    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 +
    +
    +
    @@ -106780,10 +120310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - pci-id + l3-interface-ipv4-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -106794,22 +120324,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -106841,35 +120355,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -106932,10 +120434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - pci-id + l3-interface-ipv4-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -106946,6 +120448,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -106977,23 +120495,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -107056,10 +120586,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv4-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -107101,19 +120631,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -107175,62 +120710,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + @@ -107242,29 +120733,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -107287,17 +120755,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    returns l3-interface-ipv6-address-list

    @@ -107361,10 +120829,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 - -

    MAC address for the interface

    -     		query - string - - -
    - network-name + l3-interface-ipv4-address -

    Name of the network

    +

    IP address

    		querypath string +
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -107452,10 +120920,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + neutron-network-id -

    This indicates the customers VPN ID associated with this vlan

    +

    Neutron network id of the interface that address belongs to

    +     		query + string + + +
    + neutron-subnet-id + +

    Neutron id of subnet that address belongs to

    		 query @@ -107491,7 +120974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /l3-interface-ipv6-address-list
    @@ -107519,17 +121002,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -107538,13 +121021,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /vlan + /l3-interface-ipv6-address-list
    @@ -107610,10 +121093,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -107655,23 +121138,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    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 +
    +
    +
    @@ -107734,10 +121229,134 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    +     		path + 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 @@ -107795,19 +121414,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/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
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -107869,23 +121505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -107899,141 +121519,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - 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 - - -
    @@ -108043,29 +121528,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -108088,35 +121550,23 @@ 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}/p-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 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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    @@ -108179,23 +121629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -108240,23 +121674,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/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 l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -108317,54 +121763,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -108396,35 +121794,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /network/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

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -108485,38 +121871,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -108548,24 +121902,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    returns 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
    -

    delete an existing relationship

    +

    returns sriov-vfs

    -
    - -

    application/json application/xml -

    -
    @@ -108627,34 +121976,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + @@ -108666,6 +122043,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vfs +
    +
    +
    + +
    default @@ -108688,17 +122088,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}/p-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 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 l3-interface-ipv6-address-list

    +

    returns sriov-vf

    @@ -108762,26 +122162,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv4-address + interface-id -

    IP address

    +

    ID of interface

    		pathquery + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query string -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -108854,14 +122238,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + vf-vlan-filter -

    Inner VLAN tag

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query - integer + string @@ -108869,10 +122253,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vf-mac-filter -

    This indicates the customers VPN ID associated with this vlan

    +

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    		 query @@ -108884,14 +122268,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + vf-vlan-strip -

    Inner VLAN tag

    +

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    		 query - integer + boolean @@ -108902,22 +122286,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

    +

    Neutron network id of the interface

    		 query @@ -108953,7 +122322,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /sriov-vf
    @@ -108981,17 +122350,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}/p-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 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 l3-interface-ipv6-address-list

    +

    create or update an existing sriov-vf

    @@ -109000,13 +122369,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

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l3-interface-ipv6-address-list + /sriov-vf
    @@ -109072,26 +122441,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -109133,23 +122486,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -109212,26 +122577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -109242,22 +122591,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -109289,35 +122622,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-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 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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -109380,10 +122701,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -109396,12 +122717,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -109441,23 +122762,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/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
    +

    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -109520,26 +122853,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -109581,35 +122898,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -109672,10 +122977,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -109717,24 +123022,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns vlans

    -
    - -

    application/json application/xml -

    -
    @@ -109796,122 +123096,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery 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 -
    -
    -
    -
    -
    - - - - - - - - - - - - + - + + + + + + + + @@ -109923,6 +123163,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlans +
    +
    +
    + +
    default @@ -109945,24 +123208,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}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    - equipment-name + interface-id +

    ID of interface

    		pathquery string -
    - interface-name + macaddr -

    Name that identifies the physical interface

    +

    MAC address for the interface

    		pathquery + string + + +
    + network-name + +

    Name of the network

    +     		query string -
    @@ -110006,84 +123264,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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 + interface-name +

    Name given to the interface

    		 path @@ -110094,72 +123280,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - -
    - equipment-name + vlan-interface +

    String that identifies the interface

    		 path @@ -110170,148 +123296,27 @@ 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 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 + prov-status -

    VPN ID, globally unique within A&AI

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - vpn-name + interface-id -

    VPN Name

    +

    ID of interface

    		 query @@ -110323,10 +123328,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - global-route-target + macaddr -

    Number used to identify a VPN, globally unique in the network

    +

    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 @@ -110362,7 +123412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vpn-binding + /vlan
    @@ -110390,17 +123440,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vpn-binding
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    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 vpn-binding

    +

    create or update an existing vlan

    @@ -110409,13 +123459,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vpn-binding object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /vpn-binding + /vlan
    @@ -110434,10 +123484,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + equipment-name -

    VPN ID, globally unique within A&AI

    		 path @@ -110448,73 +123497,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing vpn-binding
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

    - Tags: - Network -
    -
    -
    -

    delete an existing vpn-binding

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vpn-id + interface-name -

    VPN ID, globally unique within A&AI

    +

    Name that identifies the physical interface

    		 path @@ -110527,12 +123515,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string @@ -110572,17 +123576,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing vlan

    @@ -110591,13 +123595,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

    +

    vlan object that needs to be created or updated.

    - /relationship + /vlan
    @@ -110616,10 +123620,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + equipment-name -

    VPN ID, globally unique within A&AI

    +     		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 @@ -110661,17 +123712,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing vlan

    @@ -110693,10 +123744,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + equipment-name -

    VPN ID, globally unique within A&AI

    		 path @@ -110707,6 +123757,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + 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 + + + +
    @@ -110738,81 +123852,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    -
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model

    +

    returns l3-interface-ipv4-address-list

    @@ -110829,10 +123879,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -110845,10 +123894,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    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 @@ -110860,10 +123973,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + interface-id -

    Name of the model, which can change from version to version.

    +

    ID of interface

    		 query @@ -110875,10 +123988,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-id + macaddr -

    Invariant unique ID which does not change from version to version

    +

    MAC address for the interface

    		 query @@ -110890,10 +124003,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + network-name -

    Version

    +

    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 @@ -110929,7 +124117,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model + /l3-interface-ipv4-address-list
    @@ -110957,17 +124145,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing model
    -

    PUT /service-design-and-creation/models/model/{model-name-version-id}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing model

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -110976,13 +124164,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /model + /l3-interface-ipv4-address-list
    @@ -111001,10 +124189,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -111015,73 +124202,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the physical interface

    		 path @@ -111094,12 +124220,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string @@ -111139,19 +124297,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadata
    -

    GET /service-design-and-creation/models/model/{model-name-version-id}/metadata

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns metadata

    +

    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 +
    +
    +
    +
    @@ -111166,10 +124341,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - + @@ -111249,29 +124427,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadata -
    -
    -
    - -
    default @@ -111294,19 +124449,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadatum
    -

    GET /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns metadatum

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -111182,62 +124356,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name that identifies the physical interface

    		querypath string +
    - model-name + interface-name -

    Name of the model, which can change from version to version.

    +

    Name given to the interface

    		querypath string +
    - model-id + vlan-interface -

    Invariant unique ID which does not change from version to version

    +

    String that identifies the interface

    		querypath string +
    - model-version + l3-interface-ipv4-address -

    Version

    +

    IP address

    		querypath string +
    @@ -111321,10 +124481,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -111419,29 +124583,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadatum -
    -
    -
    - -
    default @@ -111464,17 +124605,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing metadatum
    -

    PUT /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing metadatum

    +

    see node definition for valid relationships

    @@ -111483,13 +124624,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /metadatum + /relationship
    @@ -111508,10 +124649,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + - + + + + + + + + - + - + - -
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -111337,9 +124496,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + interface-name +

    Name that identifies the physical interface

    		 path @@ -111352,55 +124512,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name given to the interface

    		querypath string +
    - model-name + vlan-interface -

    Name of the model, which can change from version to version.

    +

    String that identifies the interface

    		querypath string +
    - model-id + l3-interface-ipv4-address -

    Invariant unique ID which does not change from version to version

    +

    IP address

    		querypath string +
    - model-version + resource-version -

    Version

    +

    resource-version for concurrency

    		 query @@ -111408,6 +124571,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -111524,9 +124664,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + 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 @@ -111568,17 +124757,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing metadatum
    -

    DELETE /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing metadatum

    +

    delete an existing relationship

    @@ -111600,10 +124789,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -111616,9 +124804,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + interface-name +

    Name that identifies the physical interface

    		 path @@ -111631,12 +124820,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string @@ -111676,17 +124897,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-elements
    -

    GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model-elements

    +

    returns l3-interface-ipv6-address-list

    @@ -111703,10 +124924,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -111719,55 +124939,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path string +
    - model-name + vlan-interface -

    Name of the model, which can change from version to version.

    +

    String that identifies the interface

    		querypath string +
    - model-id + l3-interface-ipv6-address -

    Invariant unique ID which does not change from version to version

    +

    IP address

    		querypath string +
    - model-version + prov-status -

    Version

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -111777,122 +125016,42 @@ 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

    - -
    -
    - - - - - - - - - - - - + - + + + + + + + + + + + + + + + - -
    - model-name-version-id + interface-id -

    Unique identifier corresponding to one version of a model in ASDC

    +

    ID of interface

    		pathquery string -
    - model-element-uuid + macaddr +

    MAC address for the interface

    		pathquery string -
    - model-type + network-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name of the network

    		 query @@ -111904,10 +125063,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + vlan-id-inner -

    Name of the model, which can change from version to version.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -111919,10 +125093,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-id + vlan-id-inner -

    Invariant unique ID which does not change from version to version

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -111934,10 +125123,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + neutron-subnet-id -

    Version

    +

    Neutron id of subnet that address belongs to

    		 query @@ -111973,7 +125162,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-element + /l3-interface-ipv6-address-list
    @@ -112001,17 +125190,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing model-element

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -112020,13 +125209,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model-element object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /model-element + /l3-interface-ipv6-address-list
    @@ -112045,10 +125234,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -112061,9 +125249,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -112074,73 +125263,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name given to the interface

    		 path @@ -112153,9 +125281,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + vlan-interface +

    String that identifies the interface

    		 path @@ -112168,12 +125297,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -112213,19 +125342,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-constraints
    -

    GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model-constraints

    +

    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 +
    +
    +
    +
    @@ -112240,10 +125386,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + - + @@ -112338,29 +125472,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-constraints -
    -
    -
    - -
    default @@ -112383,19 +125494,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model-constraint

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -112256,9 +125401,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -112271,62 +125417,50 @@ 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 + interface-name -

    Name of the model, which can change from version to version.

    +

    Name given to the interface

    		querypath string +
    - model-id + vlan-interface -

    Invariant unique ID which does not change from version to version

    +

    String that identifies the interface

    		querypath string +
    - model-version + l3-interface-ipv6-address -

    Version

    +

    IP address

    		querypath string +
    @@ -112410,10 +125526,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -112523,29 +125628,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-constraint -
    -
    -
    - -
    default @@ -112568,17 +125650,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing model-constraint
    -

    PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing model-constraint

    +

    see node definition for valid relationships

    @@ -112587,13 +125669,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model-constraint object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /model-constraint + /relationship
    @@ -112612,10 +125694,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + - + + + + + + + + - - - - - - - - - - - - - - @@ -113285,9 +126261,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -112426,9 +125541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -112441,9 +125557,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -112456,55 +125573,42 @@ 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 + vlan-interface -

    Name of the model, which can change from version to version.

    +

    String that identifies the interface

    		querypath string +
    - model-id + l3-interface-ipv6-address -

    Invariant unique ID which does not change from version to version

    +

    IP address

    		querypath string +
    - model-version + resource-version -

    Version

    +

    resource-version for concurrency

    		 query @@ -112512,6 +125616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -112628,9 +125709,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -112643,9 +125725,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + 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 @@ -112687,17 +125802,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing model-constraint
    -

    DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing model-constraint

    +

    delete an existing relationship

    @@ -112719,10 +125834,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -112735,9 +125849,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -112750,9 +125865,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -112765,12 +125881,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -112810,19 +125942,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns constrained-element-sets
    -

    GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns constrained-element-sets

    +

    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/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -112837,10 +125986,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + @@ -112950,29 +126056,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /constrained-element-sets -
    -
    -
    - -
    default @@ -112995,19 +126078,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns constrained-element-set
    -

    GET /service-design-and-creation/models/model/{model-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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns constrained-element-set

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -112853,9 +126001,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -112868,9 +126017,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -112883,62 +126033,18 @@ 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 + vlan-interface -

    Version

    +

    String that identifies the interface

    		querypath string +
    @@ -113022,10 +126110,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -113038,9 +126125,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -113053,9 +126141,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -113068,9 +126157,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + vlan-interface +

    String that identifies the interface

    		 path @@ -113081,66 +126171,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type - -

    Type of the model, e.g., service, resource, widget, etc.

    -     		query - string - - -
    - model-name - -

    Name of the model, which can change from version to version.

    -     		query - string - - -
    - model-id - -

    Invariant unique ID which does not change from version to version

    -     		query - string - - -
    - model-version - -

    Version

    -     		query - string - - -
    @@ -113150,29 +126180,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /constrained-element-set -
    -
    -
    - -
    default @@ -113195,17 +126202,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing constrained-element-set
    -

    PUT /service-design-and-creation/models/model/{model-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}

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    -

    create or update an existing constrained-element-set

    +

    see node definition for valid relationships

    @@ -113214,13 +126221,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    constrained-element-set object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)

    - /constrained-element-set + /relationship
    @@ -113239,38 +126246,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + equipment-name
    - constrained-element-set-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -113329,17 +126306,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing constrained-element-set
    -

    DELETE /service-design-and-creation/models/model/{model-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}

    +
    delete an existing relationship
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing constrained-element-set

    +

    delete an existing relationship

    @@ -113361,10 +126338,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -113377,9 +126353,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the physical interface

    		 path @@ -113390,52 +126367,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid - - path - string - - - -
    - constrained-element-set-uuid - - path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -113467,19 +126398,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns element-choice-sets
    -

    GET /service-design-and-creation/models/model/{model-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

    +
    see node definition for valid relationships
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    -

    returns element-choice-sets

    +

    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/v8/NetworkVplsPesVplsPe.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -113494,38 +126442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -113538,9 +126455,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - 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 + equipment-name
    +
    + +
    +

    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 +

    +
    +
    + + + + + + + + + + + @@ -113553,70 +126531,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - constrained-element-set-uuid + equipment-name
    - 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 +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns vpn-bindings
    +

    GET /network/vpn-bindings

    + Tags: + Network +
    +
    +
    +

    returns vpn-bindings

    + +
    +

    application/json application/xml

    @@ -113639,7 +126598,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /element-choice-sets + /vpn-bindings
    @@ -113667,17 +126626,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns element-choice-set
    -

    GET /service-design-and-creation/models/model/{model-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}

    +
    returns vpn-binding
    +

    GET /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: - ServiceDesignAndCreation + Network
    -

    returns element-choice-set

    +

    returns vpn-binding

    @@ -113694,70 +126653,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vpn-id +

    VPN ID, globally unique within A&AI

    		 path @@ -113770,40 +126669,10 @@ 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 + vpn-name -

    Invariant unique ID which does not change from version to version

    +

    VPN Name

    		 query @@ -113815,10 +126684,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + global-route-target -

    Version

    +

    Number used to identify a VPN, globally unique in the network

    		 query @@ -113854,7 +126723,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /element-choice-set + /vpn-binding
    @@ -113882,17 +126751,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing element-choice-set
    -

    PUT /service-design-and-creation/models/model/{model-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}

    +
    create or update an existing vpn-binding
    +

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: - ServiceDesignAndCreation + Network
    -

    create or update an existing element-choice-set

    +

    create or update an existing vpn-binding

    @@ -113901,13 +126770,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    element-choice-set object that needs to be created or updated

    +

    vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)

    - /element-choice-set + /vpn-binding
    @@ -113926,70 +126795,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vpn-id +

    VPN ID, globally unique within A&AI

    		 path @@ -114031,23 +126840,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing element-choice-set
    -

    DELETE /service-design-and-creation/models/model/{model-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}

    +
    update an existing vpn-binding
    +

    PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing element-choice-set

    +

    update an existing vpn-binding

    application/json application/xml

    +
    +
    +

    vpn-binding object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vpn-binding +
    +
    +
    @@ -114063,55 +126884,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - + +
    - 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 + vpn-id +

    VPN ID, globally unique within A&AI

    		 path @@ -114122,11 +126898,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing vpn-binding
    +

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

    + Tags: + Network +
    +
    +
    +

    delete an existing vpn-binding

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - element-choice-set-uuid + vpn-id +

    VPN ID, globally unique within A&AI

    		 path @@ -114184,13 +127022,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-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

    +

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    @@ -114203,7 +127041,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)

    @@ -114228,70 +127066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vpn-id +

    VPN ID, globally unique within A&AI

    		 path @@ -114333,13 +127111,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-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

    +

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    @@ -114365,70 +127143,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vpn-id +

    VPN ID, globally unique within A&AI

    		 path @@ -114470,36 +127188,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-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}/relationship-list/relationship

    +
    returns models
    +

    GET /service-design-and-creation/models

    Tags: ServiceDesignAndCreation
    -

    see node definition for valid relationships

    +

    returns models

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    -
    -
    -
    - /relationship -
    -
    -
    -
    +
    + +
    +
    + +
    + /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

    + +
    @@ -114530,47 +127295,62 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -114582,6 +127362,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /model +
    +
    +
    + +
    default @@ -114604,23 +127407,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-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}/relationship-list/relationship

    +
    create or update an existing model
    +

    PUT /service-design-and-creation/models/model/{model-name-version-id}

    Tags: ServiceDesignAndCreation
    -

    delete an existing relationship

    +

    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/v8/ServiceDesignAndCreationModelsModel.json)

    +

    +
    +
    +
    +
    + /model +
    +
    +
    - model-element-uuid + model-type +

    Type of the model, e.g., service, resource, widget, etc.

    		pathquery string -
    - model-constraint-uuid + model-name +

    Name of the model, which can change from version to version.

    		pathquery string -
    - constrained-element-set-uuid + model-id +

    Invariant unique ID which does not change from version to version

    		pathquery + string + + +
    + model-version + +

    Version

    +     		query string -
    @@ -114650,51 +127465,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - model-element-uuid - - path - string - - - -
    - model-constraint-uuid - - path - string - - - -
    - constrained-element-set-uuid - - path - string - - - -
    @@ -114726,17 +127496,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

    +
    update an existing model
    +

    PATCH /service-design-and-creation/models/model/{model-name-version-id}

    Tags: ServiceDesignAndCreation
    -

    see node definition for valid relationships

    +

    update an existing model

    @@ -114745,13 +127515,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

    +

    model object that needs to be created or updated.

    - /relationship + /model
    @@ -114784,21 +127554,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid - - path - string - - - -
    @@ -114830,17 +127585,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

    +
    delete an existing model
    +

    DELETE /service-design-and-creation/models/model/{model-name-version-id}

    Tags: ServiceDesignAndCreation
    -

    delete an existing relationship

    +

    delete an existing model

    @@ -114878,11 +127633,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + resource-version +

    resource-version for concurrency

    		pathquery string @@ -114922,36 +127678,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship

    +
    returns metadata
    +

    GET /service-design-and-creation/models/model/{model-name-version-id}/metadata

    Tags: ServiceDesignAndCreation
    -

    see node definition for valid relationships

    +

    returns metadata

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -114980,223 +127719,57 @@ 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 /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - model-name-version-id + model-type -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Type of the model, e.g., service, resource, widget, etc.

    		pathquery string -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns named-queries
    -

    GET /service-design-and-creation/named-queries

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    returns named-queries

    - -
    - -
    -

    application/json application/xml -

    - -
    -
    - 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 + model-name +

    Name of the model, which can change from version to version.

    		pathquery string -
    - named-query-name + model-id + +

    Invariant unique ID which does not change from version to version

    +     		query + string + + +
    + model-version +

    Version

    		 query @@ -115232,7 +127805,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /named-query + /metadata
    @@ -115260,36 +127833,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing named-query
    -

    PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

    +
    returns metadatum
    +

    GET /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    Tags: ServiceDesignAndCreation
    -

    create or update an existing named-query

    +

    returns metadatum

    -
    - -

    application/json application/xml -

    -
    -
    -

    named-query object that needs to be created or updated

    -

    -
    -
    -
    -
    - /named-query -
    -
    -
    -
    @@ -115304,9 +127860,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -115317,70 +127874,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 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 -

    -
    -
    - - - - - - - - - - - @@ -115395,10 +127891,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - named-query-uuid + metaname
    - resource-version + model-type -

    resource-version for concurrency

    +

    Type of the model, e.g., service, resource, widget, etc.

    		 query @@ -115406,85 +127902,44 @@ 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 named-query-elements
    -

    GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    returns named-query-elements

    - -
    -
    - - - - - - - - - - - - + + + + + + + + @@ -115774,17 +128211,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    delete an existing metadatum
    +

    DELETE /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    Tags: ServiceDesignAndCreation
    -

    delete an existing named-query-element

    +

    delete an existing metadatum

    @@ -115806,9 +128243,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -115881,17 +128319,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    returns model-elements
    +

    GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements

    Tags: ServiceDesignAndCreation
    -

    returns property-constraints

    +

    returns model-elements

    @@ -115908,9 +128346,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + + + + + + + + + + + + + + + @@ -116061,24 +128532,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + - - - - - - - @@ -116260,23 +128748,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    update an existing model-element
    +

    PATCH /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

    Tags: ServiceDesignAndCreation
    -

    delete an existing property-constraint

    +

    update an existing model-element

    application/json application/xml

    +
    +
    +

    model-element object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /model-element +
    +
    +
    - named-query-uuid + model-name +

    Name of the model, which can change from version to version.

    		pathquery string -
    - named-query-name + model-id + +

    Invariant unique ID which does not change from version to version

    +     		query + string + +
    + model-version + +

    Version

    		 query @@ -115520,7 +127975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /named-query-elements + /metadatum
    @@ -115548,19 +128003,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    create or update an existing metadatum
    +

    PUT /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    Tags: ServiceDesignAndCreation
    -

    returns named-query-element

    +

    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/v8/ServiceDesignAndCreationModelsModelMetadataMetadatum.json)

    +

    +
    +
    +
    +
    + /metadatum +
    +
    +
    +
    @@ -115575,9 +128047,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -115603,20 +128076,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -115590,7 +128063,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + metaname
    - named-query-name - - query - string - - -
    @@ -115626,29 +128085,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /named-query-element -
    -
    -
    - -
    default @@ -115671,17 +128107,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    update an existing metadatum
    +

    PATCH /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}

    Tags: ServiceDesignAndCreation
    -

    create or update an existing named-query-element

    +

    update an existing metadatum

    @@ -115690,13 +128126,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    named-query-element object that needs to be created or updated

    +

    metadatum object that needs to be created or updated.

    - /named-query-element + /metadatum
    @@ -115715,9 +128151,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -115730,7 +128167,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + metaname
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -115821,7 +128259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + metaname
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -115923,24 +128362,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-type +

    Type of the model, e.g., service, resource, widget, etc.

    		pathquery string -
    - named-query-name + 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 @@ -115976,7 +128446,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /property-constraints + /model-elements
    @@ -116004,17 +128474,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    returns model-element
    +

    GET /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns property-constraint

    +

    returns model-element

    @@ -116031,9 +128501,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116046,7 +128517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - property-constraint-uuid + model-type +

    Type of the model, e.g., service, resource, widget, etc.

    		pathquery string -
    - named-query-name + 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 @@ -116114,7 +128616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /property-constraint + /model-element
    @@ -116142,17 +128644,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 property-constraint

    +

    create or update an existing model-element

    @@ -116161,13 +128663,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    property-constraint object that needs to be created or updated

    +

    model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)

    - /property-constraint + /model-element
    @@ -116186,24 +128688,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid - - path - string - - - -
    - named-query-element-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116216,7 +128704,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - property-constraint-uuid + model-element-uuid
    @@ -116292,9 +128792,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116320,9 +128821,86 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116307,7 +128808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    +
    + +
    +

    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 +

    +
    +
    + + + + + + + + + + + + + + + + + + @@ -116382,17 +128960,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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 related-lookups

    +

    returns model-constraints

    @@ -116409,9 +128987,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -116439,9 +129018,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + @@ -116562,7 +129188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116577,9 +129203,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + @@ -116717,7 +129390,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116761,23 +129434,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    update an existing model-constraint
    +

    PATCH /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 related-lookup

    +

    update an existing model-constraint

    application/json application/xml

    +
    +
    +

    model-constraint object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /model-constraint +
    +
    +
    - property-constraint-uuid + model-name-version-id + +

    Unique identifier corresponding to one version of a model in ASDC

    +     		path + string + + + +
    + model-element-uuid
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116424,7 +129003,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - named-query-name + 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 @@ -116477,7 +129102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /related-lookups + /model-constraints
    @@ -116505,17 +129130,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 related-lookup

    +

    returns model-constraint

    @@ -116532,9 +129157,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116547,7 +129173,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - related-lookup-uuid + model-constraint-uuid
    - named-query-name + 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 @@ -116615,7 +129287,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /related-lookup + /model-constraint
    @@ -116643,17 +129315,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 related-lookup

    +

    create or update an existing model-constraint

    @@ -116662,13 +129334,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    related-lookup object that needs to be created or updated

    +

    model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint.json)

    - /related-lookup + /model-constraint
    @@ -116687,9 +129359,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116702,7 +129375,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - related-lookup-uuid + model-constraint-uuid
    @@ -116793,9 +129478,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116823,7 +129509,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116836,22 +129522,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116808,7 +129494,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - related-lookup-uuid + model-constraint-uuid
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -116883,35 +129553,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/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 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
    -

    see node definition for valid relationships

    +

    delete an existing model-constraint

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -116927,9 +129585,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116957,7 +129616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -116970,6 +129629,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -116942,7 +129601,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - related-lookup-uuid + model-constraint-uuid
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -117001,24 +129676,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    delete an existing relationship

    +

    returns constrained-element-sets

    -
    - -

    application/json application/xml -

    -
    @@ -117033,9 +129703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -117063,7 +129734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -117076,6 +129747,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117048,7 +129719,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid
    - related-lookup-uuid + model-constraint-uuid
    + 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 + + +
    @@ -117085,6 +129816,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /constrained-element-sets +
    +
    +
    + +
    default @@ -117107,36 +129861,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/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: ServiceDesignAndCreation
    -

    see node definition for valid relationships

    +

    returns constrained-element-set

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -117151,9 +129888,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -117179,6 +129947,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117166,7 +129904,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid + + path + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid
    + 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 + + +
    @@ -117188,6 +130016,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /constrained-element-set +
    +
    +
    + +
    default @@ -117210,23 +130061,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    delete an existing relationship

    +

    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/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

    +

    +
    +
    +
    +
    + /constrained-element-set +
    +
    +
    @@ -117242,9 +130105,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -117301,17 +130195,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

    +
    update an existing constrained-element-set
    +

    PATCH /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
    -

    see node definition for valid relationships

    +

    update an existing constrained-element-set

    @@ -117320,13 +130214,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
    @@ -117345,7 +130239,53 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + @@ -117389,17 +130329,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/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: ServiceDesignAndCreation
    -

    delete an existing relationship

    +

    delete an existing constrained-element-set

    @@ -117421,7 +130361,53 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + @@ -117434,6 +130420,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - named-query-uuid + model-name-version-id +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117257,7 +130121,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + model-element-uuid + + path + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid
    - named-query-uuid + 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
    - named-query-uuid + 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
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -117465,19 +130467,155 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns service-capabilities
    -

    GET /service-design-and-creation/service-capabilities

    +
    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 service-capabilities

    +

    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 @@ -117501,7 +130639,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /service-capabilities + /element-choice-sets
    @@ -117529,17 +130667,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns service-capability
    -

    GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    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 service-capability

    +

    returns element-choice-set

    @@ -117556,10 +130694,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117572,10 +130710,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + model-element-uuid + + path + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid + + path + string + + + +
    + element-choice-set-uuid -

    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.

    		 path @@ -117586,6 +130768,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 + + +
    @@ -117612,7 +130854,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-capability + /element-choice-set
    @@ -117640,17 +130882,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing service-capability
    -

    PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    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 service-capability

    +

    create or update an existing element-choice-set

    @@ -117659,13 +130901,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-capability object that needs to be created or updated

    +

    element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

    - /service-capability + /element-choice-set
    @@ -117684,10 +130926,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117700,10 +130942,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + model-element-uuid + + path + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid + + path + string + + + +
    + element-choice-set-uuid -

    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.

    		 path @@ -117745,23 +131031,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing service-capability
    -

    DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    update an existing element-choice-set
    +

    PATCH /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 service-capability

    +

    update an existing element-choice-set

    application/json application/xml

    +
    +
    +

    element-choice-set object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /element-choice-set +
    +
    +
    @@ -117777,10 +131075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - service-type + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117793,10 +131091,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + model-element-uuid -

    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.

    		 path @@ -117809,12 +131106,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + model-constraint-uuid -

    resource-version for concurrency

    		querypath + string + + + +
    + constrained-element-set-uuid + + path + string + + + +
    + element-choice-set-uuid + + path string @@ -117854,35 +131180,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing element-choice-set

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -117898,10 +131212,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - service-type + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -117914,10 +131228,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + model-element-uuid + + path + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid + + path + string + + + +
    + element-choice-set-uuid -

    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.

    		 path @@ -117928,6 +131286,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -117959,23 +131333,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -117991,10 +131377,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - service-type + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -118007,10 +131393,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + model-element-uuid -

    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.

    		 path @@ -118021,8 +131406,53 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid + + path + string + + + +
    + element-choice-set-uuid + + path + string + + + +
    @@ -118052,48 +131482,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns services
    -

    GET /service-design-and-creation/services

    +
    delete an existing relationship
    +

    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}/relationship-list/relationship

    Tags: ServiceDesignAndCreation
    -

    returns services

    +

    delete an existing relationship

    +
    + +

    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 + + + +
    +

    application/json application/xml

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /services -
    -
    -
    - -
    default @@ -118116,19 +131619,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns service
    -

    GET /service-design-and-creation/services/service/{service-id}

    +
    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}/relationship-list/relationship

    Tags: ServiceDesignAndCreation
    -

    returns service

    +

    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/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -118143,10 +131663,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -118181,29 +131731,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK +
    + default
    -
    +
    -

    successful operation

    +

    Response codes found in response codes.

    - +
    -
    - -
    - /service -
    -
    -
    - +
    +
    +
    + + + + + +
    +
    +
    delete an existing relationship
    +

    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}/relationship-list/relationship

    + Tags: + ServiceDesignAndCreation +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +
    - service-id + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -118159,17 +131679,47 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-description + model-element-uuid -

    Description of the service

    		querypath + string + + + +
    + model-constraint-uuid + + path + string + + + +
    + constrained-element-set-uuid + + path string +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + 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 @@ -118226,17 +131875,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing service
    -

    PUT /service-design-and-creation/services/service/{service-id}

    +
    see node definition for valid relationships
    +

    PUT /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

    Tags: ServiceDesignAndCreation
    -

    create or update an existing service

    +

    see node definition for valid relationships

    @@ -118245,13 +131894,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)

    - /service + /relationship
    @@ -118270,10 +131919,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + model-name-version-id + +

    Unique identifier corresponding to one version of a model in ASDC

    +     		path + string + + + +
    + model-element-uuid -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -118315,17 +131979,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing service
    -

    DELETE /service-design-and-creation/services/service/{service-id}

    +
    delete an existing relationship
    +

    DELETE /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

    Tags: ServiceDesignAndCreation
    -

    delete an existing service

    +

    delete an existing relationship

    @@ -118347,10 +132011,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -118363,12 +132027,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + model-element-uuid -

    resource-version for concurrency

    		querypath string @@ -118408,11 +132071,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

    +

    PUT /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship

    Tags: ServiceDesignAndCreation
    @@ -118427,7 +132090,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)

    @@ -118452,10 +132115,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -118497,11 +132160,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

    +

    DELETE /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship

    Tags: ServiceDesignAndCreation
    @@ -118529,10 +132192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + model-name-version-id -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -118574,17 +132237,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vnf-images
    -

    GET /service-design-and-creation/vnf-images

    +
    returns named-queries
    +

    GET /service-design-and-creation/named-queries

    Tags: ServiceDesignAndCreation
    -

    returns vnf-images

    +

    returns named-queries

    @@ -118610,7 +132273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnf-images + /named-queries
    @@ -118638,17 +132301,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vnf-image
    -

    GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    returns named-query
    +

    GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

    Tags: ServiceDesignAndCreation
    -

    returns vnf-image

    +

    returns named-query

    @@ -118665,10 +132328,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-image-uuid + named-query-uuid -

    Unique ID of this asset

    		 path @@ -118681,10 +132343,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - application + named-query-name -

    The application that the image instantiates.

    		 query @@ -118694,12 +132355,287 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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/v8/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 +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + +
    - application-vendor + named-query-uuid -

    The vendor of the application.

    +     		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 @@ -118707,14 +132643,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + @@ -82,6 +89,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -112,6 +124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -142,6 +159,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -172,6 +194,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -202,6 +229,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -222,6 +254,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -252,6 +289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -292,6 +334,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -322,6 +369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -352,6 +404,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -372,6 +429,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -387,6 +449,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -412,6 +479,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -452,6 +524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -482,6 +559,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -497,6 +579,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -522,6 +609,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -572,6 +664,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -602,6 +699,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -632,6 +734,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -652,6 +759,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -692,6 +804,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -722,6 +839,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -742,6 +864,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -762,6 +889,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -777,6 +909,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -802,6 +939,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -842,6 +984,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -872,6 +1019,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -887,6 +1039,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -912,6 +1069,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -962,6 +1124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -982,6 +1149,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -997,6 +1169,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1022,6 +1199,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1062,6 +1244,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1092,6 +1279,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1107,6 +1299,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1132,6 +1329,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1192,6 +1394,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1236,6 +1443,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1256,6 +1468,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1286,6 +1503,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1316,6 +1538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1346,6 +1573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1366,6 +1598,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1396,6 +1633,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1426,6 +1668,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1470,6 +1717,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1490,6 +1742,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1510,6 +1767,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1530,6 +1792,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1550,6 +1817,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1570,6 +1842,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1590,6 +1867,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1660,6 +1942,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1680,6 +1967,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1700,6 +1992,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1720,6 +2017,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1770,6 +2072,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1800,6 +2107,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1830,6 +2142,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1874,6 +2191,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1894,6 +2216,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1924,6 +2251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1939,6 +2271,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1964,6 +2301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2004,6 +2346,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2034,6 +2381,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2049,6 +2401,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2074,6 +2431,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2114,6 +2476,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2134,6 +2501,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2149,6 +2521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2174,6 +2551,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2214,6 +2596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2244,6 +2631,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2259,6 +2651,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2284,6 +2681,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2334,6 +2736,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2374,6 +2781,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2404,6 +2816,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2434,6 +2851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2464,6 +2886,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2494,6 +2921,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2514,6 +2946,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2554,6 +2991,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2584,6 +3026,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2614,6 +3061,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2644,6 +3096,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2674,6 +3131,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2704,6 +3166,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2734,6 +3201,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2754,6 +3226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2769,6 +3246,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2794,6 +3276,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2834,6 +3321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2864,6 +3356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2879,6 +3376,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2904,6 +3406,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2954,6 +3461,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2984,6 +3496,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3004,6 +3521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3024,6 +3546,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3039,6 +3566,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3064,6 +3596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3104,6 +3641,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3134,6 +3676,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3149,6 +3696,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3174,6 +3726,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3224,6 +3781,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3244,6 +3806,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3259,6 +3826,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3284,6 +3856,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3324,6 +3901,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3354,6 +3936,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3369,6 +3956,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3394,6 +3986,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3454,6 +4051,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3484,6 +4086,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3514,6 +4121,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3544,6 +4156,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3564,6 +4181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3604,6 +4226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3624,6 +4251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3654,6 +4286,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3684,6 +4321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3704,6 +4346,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3754,6 +4401,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3784,6 +4436,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3804,6 +4461,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3824,6 +4486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3839,6 +4506,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3864,6 +4536,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3904,6 +4581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3934,6 +4616,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3949,6 +4636,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3974,6 +4666,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4024,6 +4721,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4044,6 +4746,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4059,6 +4766,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4084,6 +4796,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4124,6 +4841,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4154,6 +4876,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4169,6 +4896,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4194,6 +4926,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4254,6 +4991,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4284,6 +5026,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4346,7 +5093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /connectors + /connectors
    @@ -4501,7 +5248,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /connector + /connector
    @@ -4548,7 +5295,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    connector object that needs to be created or updated

    +

    connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)

    @@ -4618,6 +5365,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing connector
    +

    PATCH /business/connectors/connector/{resource-instance-id}

    + Tags: + Business +
    +
    +
    +

    update an existing connector

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    connector object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /connector +
    +
    +
    +
    +
    +
    + named-query-uuid + + path + string + + +
    - application-version + named-query-name -

    The version of the application.

    		 query @@ -118750,7 +132757,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnf-image + /named-query-elements
    @@ -118778,36 +132785,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vnf-image
    -

    PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    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
    -

    create or update an existing vnf-image

    +

    returns named-query-element

    -
    - -

    application/json application/xml -

    -
    -
    -

    vnf-image object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vnf-image -
    -
    -
    -
    @@ -118822,10 +132812,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - vnf-image-uuid + named-query-uuid + + path + string + + + +
    + named-query-element-uuid -

    Unique ID of this asset

    		 path @@ -118836,6 +132840,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + named-query-name + + query + string + + +
    @@ -118845,6 +132863,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /named-query-element +
    +
    +
    + +
    default @@ -118867,23 +132908,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vnf-image
    -

    DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    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
    -

    delete an existing vnf-image

    +

    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/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

    +

    +
    +
    +
    +
    + /named-query-element +
    +
    +
    @@ -118899,10 +132952,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + +
    - vnf-image-uuid + named-query-uuid -

    Unique ID of this asset

    		 path @@ -118915,12 +132967,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + named-query-element-uuid -

    resource-version for concurrency

    		querypath string @@ -118960,17 +133011,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing named-query-element

    @@ -118979,13 +133030,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

    +

    named-query-element object that needs to be created or updated.

    - /relationship + /named-query-element
    @@ -119004,10 +133055,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-image-uuid + named-query-uuid + + path + string + + + +
    + named-query-element-uuid -

    Unique ID of this asset

    		 path @@ -119049,17 +133114,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing named-query-element

    @@ -119081,10 +133146,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-image-uuid + named-query-uuid + + path + string + + + +
    + named-query-element-uuid -

    Unique ID of this asset

    		 path @@ -119095,6 +133174,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -119125,45 +133220,3848 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - -

    Schema definitions

    - -
    -
    -

    action: - object - - - -

    -
    -
    - -
    -
    -
    - action-type: - string - - -
    -
    -
    - -
    -
    -
    - action-data: - object[] - - -
    -
    - -
    - -
    + + +
    +
    +
    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/v8/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/v8/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/v8/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/v8/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/v8/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 and clients should expect changes to occur in the future to this field as ASDC 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/v8/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 and clients should expect changes to occur in the future to this field as ASDC 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 and clients should expect changes to occur in the future to this field as ASDC 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 and clients should expect changes to occur in the future to this field as ASDC 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/v8/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 and clients should expect changes to occur in the future to this field as ASDC 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 and clients should expect changes to occur in the future to this field as ASDC 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/v8/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/v8/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/v8/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/v8/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 @@ -119177,9 +137075,1492 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    +
    +

    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 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
      • +
    • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
      • +
    • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
      • +
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
      • +
    • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
    + +
    + +
    +
    +
    + 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

    +
    + +
    +
    +
    + persona-model-id: + string + + +
    +
    +

    the ASDC model id for this resource or service model.

    +
    + +
    +
    +
    + persona-model-version: + string + + +
    +
    +

    the ASDC model version for this resource or service model.

    +
    + +
    +
    +
    + model-version-id: + string + + +
    +
    +

    the ASDC model version for this resource or service model.

    +
    + +
    +
    +
    + persona-model-customization-id: + string + + +
    +
    +

    captures the id of all the configuration used to customize the resource for the service.

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Concurrency value

    +
    + +
    +
    +
    + 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-state: + 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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    cloud-region: + object + + + +

    +
    +
    +
    +

    cloud-region designates an installation of a cloud cluster or region or instantiation.

    + +
      +
    • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
      • +
    • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
      • +
    • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
      • +
    • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
    + +
    + +
    +
    +
    + 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

    +
    + +
    +
    +
    + identity-url: + string + + +
    +
    +

    URL of the keystone identity service

    +
    + +
    +
    +
    + cloud-zone: + string + + +
    +
    +

    Zone where the cloud is homed

    +
    + +
    +
    +
    + complex-name: + string + + +
    +
    +

    complex name for cloud-region instance

    +
    + +
    +
    +
    + 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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    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 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)
      • +
    • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
      • +
    • 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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    -

    action-data: +

    complexes: object @@ -119187,38 +138568,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Collection of physical locations that can house cloud-regions.

    + +
    -
    - property-name: - string +
    + complex: + object[]
    -
    - -
    -
    -
    - property-value: - string - -
    -
    -
    +
    + complex + + + +
    + +
    +
    -
    +
    -

    actions: +

    configuration: object @@ -119227,15 +138610,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    APIs that are more action related than REST (e.g., notify, update).

    +

    Port Mirror Configuration.

    + +
      +
    • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
      • +
    • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
      • +
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
      • +
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
      • +
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
      • +
    • CONFIGURATION is DELETED when these are DELETED METADATUM
      • +
    • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
    -
    - update: - object +
    + 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

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[]
    @@ -119244,7 +138787,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - update + relationship @@ -119253,9 +138796,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - notify: - object +
    + metadata: + object[]
    @@ -119264,7 +138807,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - notify + metadatum @@ -119277,9 +138820,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    availability-zone: +

    configurations: object @@ -119288,70 +138831,140 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Availability zone, a collection of compute hosts/pservers

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    +

    Collection of configurations

    + +
    + +
    +
    +
    + configuration: + object[] + + +
    +
    + +
    + +
    + configuration + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    connector: + object + + + +

    +
    +
    +
    +

    Collection of resource instances used to connect a variety of disparate inventory widgets

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of availability-zone)
      • -
    • FROM ctag-pool
      • -
    • FROM dvs-switch
      • -
    • FROM generic-vnf
      • -
    • FROM pserver
      • -
    • FROM vce
    +
  • 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
    • -
    - availability-zone-name: +
    + resource-instance-id: string
    -

    Name of the availability zone. Unique across a cloud region

    +

    Unique id of resource instance.

    -
    - hypervisor-type: +
    + resource-version: string -
    -

    Type of hypervisor. Source of truth should define valid values.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - operational-state: +
    + persona-model-id: string
    -

    State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

    +

    the ASDC model id for this resource or service model.

    -
    - resource-version: +
    + persona-model-version: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    the ASDC model version for this resource or service model.

    +
    + +
    +
    +
    + model-version-id: + 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.

    @@ -119373,6 +138986,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    + +
    + metadata: + object[] + + +
    +
    + +
    + +
    + metadatum + + + +
    +
    @@ -119380,9 +139013,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    availability-zones: +

    connectors: object @@ -119391,14 +139024,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of availability zones

    +

    Collection of resource instances used to connect a variety of disparate inventory widgets

    -
    - availability-zone: +
    + connector: object[] @@ -119408,7 +139041,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + connector @@ -119421,9 +139054,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    az-and-dvs-switches: +

    constrained-element-set: object @@ -119431,12 +139064,69 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    This is how we would capture constraints defining allowed sets of elements.

    + +
      +
    • TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
      • +
    • TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
      • +
    • FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
      • +
    • CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
    + +
    -
    - dvs-switches: - object +
    + constrained-element-set-uuid: + string + + + +
    +
    +
    + +
    +
    +
    + constraint-type: + string + + + +
    +
    +
    + +
    +
    +
    + check-type: + string + + + +
    +
    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +
    + +
    +
    +
    + element-choice-sets: + object[]
    @@ -119445,7 +139135,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - dvs-switches + element-choice-set @@ -119454,9 +139144,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - availability-zone: - object +
    + relationship-list: + object[]
    @@ -119465,7 +139155,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + relationship @@ -119478,9 +139168,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    business: +

    constrained-element-sets: + object + + + +

    +
    +
    + +
    +
    +
    + constrained-element-set: + object[] + + +
    +
    + +
    + +
    + constrained-element-set + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    ctag-assignment: object @@ -119489,14 +139216,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Namespace for business related constructs

    + +
      +
    • TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    -
    - connectors: +
    + 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[] @@ -119506,7 +139260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - connector + relationship @@ -119515,8 +139269,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - customers: + + +
    +
    +
    +
    +

    ctag-assignments: + object + + + +

    +
    +
    + +
    +
    +
    + ctag-assignment: object[] @@ -119526,7 +139297,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - customer + ctag-assignment @@ -119539,9 +139310,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    class-of-service: +

    ctag-pool: object @@ -119550,47 +139321,64 @@ 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.

    +
      -
    • FROM site-pair (is composed of class-of-service)
    +
  • TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
    • +
  • TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • -
    - cos: +
    + target-pe: string
    -

    unique identifier of probe

    +

    The Target provider edge router

    -
    - probe-id: +
    + availability-zone-name: string +
    -

    identifier of probe

    +

    Name of the availability zone

    -
    - probe-type: +
    + ctag-pool-purpose: string +
    -

    type of probe

    +

    Describes what the intended purpose of this pool is.

    +
    + +
    +
    +
    + ctag-values: + string + + +
    +
    +

    Comma separated list of ctags

    @@ -119631,9 +139419,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    classes-of-service: +

    ctag-pools: object @@ -119641,15 +139429,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    class-of-service of probe

    - -
    -
    - class-of-service: +
    + ctag-pool: object[] @@ -119659,7 +139443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - class-of-service + ctag-pool @@ -119672,9 +139456,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-infrastructure: +

    customer: object @@ -119683,14 +139467,69 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Namespace for cloud infrastructure.

    +

    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
    -
    - complexes: +
    + 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[] @@ -119700,7 +139539,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - complex + service-subscription @@ -119709,8 +139548,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - cloud-regions: +
    + relationship-list: object[] @@ -119720,7 +139559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region + relationship @@ -119729,8 +139568,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - network-profiles: + + +
    +
    +
    +
    +

    customers: + object + + + +

    +
    +
    +
    +

    Collection of customer identifiers to provide linkage back to BSS information.

    + +
    + +
    +
    +
    + customer: object[] @@ -119740,7 +139600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-profile + customer @@ -119749,8 +139609,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - pservers: + + +
    +
    +
    +
    +

    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[] @@ -119760,7 +139662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver + relationship @@ -119769,8 +139671,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - virtual-data-centers: + + +
    +
    +
    +
    +

    cvlan-tags: + object + + + +

    +
    +
    + +
    +
    +
    + cvlan-tag-entry: object[] @@ -119780,7 +139699,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - virtual-data-center + cvlan-tag-entry @@ -119793,9 +139712,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-region: +

    dvs-switch: object @@ -119804,122 +139723,428 @@ 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.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    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 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)
      • -
    • FROM pserver
    +
  • 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)
    • -
    - cloud-owner: +
    + switch-name: string
    -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    DVS switch name

    -
    - cloud-region-id: +
    + vcenter-url: string
    -

    Identifier used by the vendor for the region. Second part of composite key

    +

    URL used to reach the vcenter

    -
    - cloud-type: +
    + resource-version: string
    -

    Type of the cloud (e.g., openstack)

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - owner-defined-type: +
    + 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
    -

    Cloud-owner defined type indicator (e.g., DCP, LCP)

    -
    - cloud-region-version: +
    + direction: + string + + +
    +
    +
    + +
    +
    +
    + multiplicityRule: + string + + +
    +
    +
    + +
    +
    +
    + isParent: + boolean + + +
    +
    +
    + +
    +
    +
    + usesResource: + boolean + + +
    +
    +
    + +
    +
    +
    + hasDelTarget: + boolean + + +
    +
    +
    + +
    +
    +
    + SVC-INFRA: + boolean + + +
    +
    +
    + +
    +
    +
    + SVC-INFRA-REV: + boolean + + +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    edge-tag-query-request: + object + + + +

    +
    +
    + +
    +
    +
    + edge-tag: + string + + +
    +
    +
    + +
    +
    +
    + result-detail: + string + + +
    +
    +
    + +
    +
    +
    + start-node-type: string
    -

    Software version employed at the site

    -
    +
    + +
    + 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 + + + +
    + +
    +
    -
    - identity-url: +
    +
    +
    +
    +
    +
    +

    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 +
    -

    URL of the keystone identity service

    -
    - cloud-zone: +
    + element-choice-set-name: string +
    -

    Zone where the cloud is homed

    -
    - complex-name: +
    + cardinality: string
    -

    complex name for cloud-region instance

    @@ -119931,13 +140156,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - volume-groups: +
    + model-elements: object[] @@ -119947,7 +140171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group + model-element @@ -119956,8 +140180,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - tenants: +
    + relationship-list: object[] @@ -119967,7 +140191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant + relationship @@ -119976,8 +140200,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - flavors: + + +
    +
    +
    +
    +

    element-choice-sets: + object + + + +

    +
    +
    + +
    +
    +
    + element-choice-set: object[] @@ -119987,7 +140228,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - flavor + element-choice-set @@ -119996,48 +140237,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - group-assignments: - object[] + + +
    +
    +
    +
    +

    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.

    -
    - group-assignment - - - -
    - -
    -
    +
    -
    - snapshots: - object[] +
    + resource-uuid: + string +
    +

    Unique ID of an entitlement resource.

    +
    + +
    +
    +
    + resource-version: + string + +
    +
    +

    Concurrency value

    -
    - snapshot - - - -
    - -
    -
    +
    -
    - images: +
    + relationship-list: object[] @@ -120047,7 +140311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - image + relationship @@ -120056,8 +140320,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - dvs-switches: + + +
    +
    +
    +
    +

    entitlements: + object + + + +

    +
    +
    +
    +

    Entitlements, keyed by group-uuid and resource-uuid, related to license management

    + +
    + +
    +
    +
    + entitlement: object[] @@ -120067,7 +140352,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - dvs-switch + entitlement @@ -120076,29 +140361,59 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - oam-networks: - object[] + + +
    +
    +
    +
    +

    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.

    -
    - oam-network - - - -
    - -
    -
    +
    -
    - availability-zones: - object[] +
    + esr-system-info-list: + object
    @@ -120107,7 +140422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + esr-system-info-list @@ -120118,7 +140433,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -120127,7 +140442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -120140,9 +140455,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-regions: +

    esr-ems-list: object @@ -120153,8 +140468,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - cloud-region: +
    + esr-ems: object[] @@ -120164,7 +140479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region + esr-ems @@ -120177,9 +140492,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    +
    -

    complex: +

    esr-system-info: object @@ -120188,243 +140503,261 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of physical locations that can house cloud-regions.

    +

    Persist common address information of external systems.

      -
    • TO ctag-pool (comprises complex, Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • FROM availability-zone
      • -
    • FROM cloud-region
      • -
    • FROM oam-network
      • -
    • FROM pserver
      • -
    • FROM pnf
      • -
    • FROM vce
      • -
    • FROM vpls-pe
      • -
    • FROM volume-group
    +
  • FROM 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)
    • -
    - physical-location-id: +
    + esr-system-info-id: string
    -

    Unique identifier for physical location, e.g., CLLI

    +

    Unique ID of esr system info.

    -
    - data-center-code: +
    + system-name: string
    -

    Data center code which can be an alternate way to identify a complex

    +

    name of external system.

    -
    - complex-name: +
    + type: string
    -

    Gamma complex name for LCP instance.

    +

    type of external systems.

    -
    - identity-url: +
    + vendor: string
    -

    URL of the keystone identity service

    +

    vendor of external systems.

    -
    - resource-version: +
    + version: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    version of external systems.

    -
    - physical-location-type: +
    + service-url: string -
    -

    Type, e.g., central office, data center.

    +

    url used to access external systems.

    -
    - street1: +
    + user-name: string
    +

    username used to access external systems.

    -
    - street2: +
    + password: string +
    +

    password used to access external systems.

    -
    - city: +
    + system-type: string
    +

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    -
    - state: +
    + protocol: string
    +

    protocol of third party SDNC, for example netconf/snmp.

    -
    - postal-code: +
    + ssl-cacert: string -
    +

    ca file content if enabled ssl on auth-url.

    -
    - country: - string +
    + ssl-insecure: + boolean -
    +

    Whether to verify VIM's certificate.

    -
    - region: +
    + ip-address: string -
    +

    service IP of ftp server.

    -
    - latitude: +
    + port: string
    +

    service port of ftp server.

    -
    - longitude: +
    + cloud-domain: string
    +

    domain info for authentication.

    -
    - elevation: +
    + default-tenant: string
    +

    default tenant of VIM.

    -
    - lata: +
    + passive: + boolean + + +
    +
    +

    ftp passive mode or not.

    +
    + +
    +
    +
    + remote-path: string
    +

    resource or performance data file path.

    -
    - ctag-pools: - object[] +
    + 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.

    -
    - ctag-pool - - - -
    - -
    -
    +
    relationship-list: @@ -120450,9 +140783,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    complexes: +

    esr-system-info-list: object @@ -120461,14 +140794,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of physical locations that can house cloud-regions.

    +

    Collection of persistent block-level external system auth info.

    -
    - complex: +
    + esr-system-info: object[] @@ -120478,7 +140811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - complex + esr-system-info @@ -120491,9 +140824,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    connector: +

    esr-thirdparty-sdnc: object @@ -120502,105 +140835,69 @@ 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

    +

    Persist SDNC address information used by ONAP SDNC.

      -
    • TO virtual-data-center (Many2Many)
      • -
    • TO metadatum (comprises connector, Many2Many)
      • -
    • FROM service-instance
    +
  • 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
    • -
    - resource-instance-id: +
    + thirdparty-sdnc-id: string
    -

    Unique id of resource instance.

    -
    - -
    -
    -
    - resource-version: - string - - -
    -
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - -
    -
    -
    - persona-model-id: - string - - -
    -
    -

    the ASDC model id for this resource or service model.

    -
    - -
    -
    -
    - persona-model-version: - string - - -
    -
    -

    the ASDC model version for this resource or service model.

    +

    Unique ID of SDNC.

    -
    - model-version-id: +
    + location: string
    -

    the ASDC model version for this resource or service model.

    +

    used for DC type to indicate the location of SDNC, such as Core or Edge.

    -
    - widget-model-id: +
    + product-name: string
    -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    password used to access SDNC server.

    -
    - widget-model-version: +
    + resource-version: string
    -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - relationship-list: - object[] +
    + esr-system-info-list: + object
    @@ -120609,7 +140906,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + esr-system-info-list @@ -120618,9 +140915,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - metadata: - object[] +
    + relationship-list: + object
    @@ -120629,7 +140926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metadatum + relationship-list @@ -120642,9 +140939,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    connectors: +

    esr-thirdparty-sdnc-list: object @@ -120652,15 +140949,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

    - -
    -
    - connector: +
    + esr-thirdparty-sdnc: object[] @@ -120670,7 +140963,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - connector + esr-thirdparty-sdnc @@ -120683,9 +140976,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    constrained-element-set: +

    esr-vnfm: object @@ -120694,49 +140987,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This is how we would capture constraints defining allowed sets of elements.

    +

    Persist VNFM address information used by VF-C.

      -
    • TO element-choice-set (comprises constrained-element-set, One2Many)
      • -
    • FROM model-element (is composed of constrained-element-set)
      • -
    • FROM model-constraint (is composed of constrained-element-set)
    +
  • 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
    • -
    - constrained-element-set-uuid: +
    + vnfm-id: string
    +

    Unique ID of VNFM.

    -
    - constraint-type: +
    + vim-id: string -
    +

    indecate the VIM to deploy VNF.

    -
    - check-type: +
    + certificate-url: string -
    +

    certificate url of VNFM.

    @@ -120748,13 +141041,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - element-choice-sets: - object[] +
    + esr-system-info-list: + object
    @@ -120763,7 +141057,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - element-choice-set + esr-system-info-list @@ -120774,7 +141068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -120783,7 +141077,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -120796,9 +141090,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    constrained-element-sets: +

    esr-vnfm-list: object @@ -120809,8 +141103,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - constrained-element-set: +
    + esr-vnfm: object[] @@ -120820,7 +141114,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set + esr-vnfm @@ -120833,9 +141127,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    +
    -

    ctag-assignment: +

    evc: object @@ -120844,305 +141138,180 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    evc object is an optional child object of the Configuration object.

      -
    • FROM l3-network (is composed of ctag-assignment)
    +
  • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    • -
    - vlan-id-inner: - integer +
    + evc-id: + string
    -

    id.

    +

    Unique/key field for the evc object

    -
    - resource-version: +
    + forwarding-path-topology: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    Point-to-Point, Multi-Point

    -
    - relationship-list: - object[] +
    + cir-value: + string
    - +

    Commited Information Rate

    -
    - relationship - - - -
    - -
    -
    +
    -
    -
    -
    -
    -
    -
    -

    ctag-assignments: - object - - - -

    -
    -
    - -
    -
    -
    - ctag-assignment: - object[] +
    + cir-units: + string
    - +

    CIR units

    -
    - ctag-assignment - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    ctag-pool: - object - - - -

    -
    -
    -
    -

    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
    - -
    - -
    -
    -
    - target-pe: +
    + connection-diversity-group-id: string -
    -

    The Target provider edge router

    +

    Diversity Group ID

    -
    - availability-zone-name: +
    + service-hours: string -
    -

    Name of the availability zone

    +

    formerly Performance Group

    -
    - ctag-pool-purpose: +
    + esp-evc-circuit-id: string -
    -

    Describes what the intended purpose of this pool is.

    +

    EVC Circuit ID of ESP EVC

    -
    - ctag-values: +
    + esp-evc-cir-value: string
    -

    Comma separated list of ctags

    +

    Committed Information Rate (For ESP)

    -
    - resource-version: +
    + esp-evc-cir-units: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    CIR units (For ESP)

    -
    - relationship-list: - object[] +
    + esp-itu-code: + string
    - +

    Identifies ESP

    -
    - relationship - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    ctag-pools: - object - - - -

    -
    -
    - -
    -
    -
    - ctag-pool: - object[] +
    + collector-pop-clli: + string
    - +

    Collector POP CLLI (from the hostname of the access pnf)

    -
    - ctag-pool - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    customer: - object - - - -

    -
    -
    -
    -

    customer identifiers to provide linkage back to BSS information.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    - -
      -
    • TO service-subscription (comprises customer, Many2Many)
    - -
    - -
    -
    -
    - global-customer-id: +
    + inter-connect-type-ingress: string -
    -

    Global customer id used across ECOMP to uniquely identify customer.

    +

    Interconnect type on ingress side of EVC.

    -
    - subscriber-name: +
    + tagmode-access-ingress: string -
    -

    Subscriber name, an alternate way to retrieve a customer.

    +

    tagode for collector side of EVC

    -
    - subscriber-type: +
    + tagmode-access-egress: string -
    -

    Subscriber type, a way to provide VID with only the INFRA customers.

    +

    tagMode for network side of EVC

    @@ -121154,31 +141323,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - service-subscriptions: - object[] - - -
    -
    - -
    - -
    - service-subscription - - - -
    - -
    -
    -
    relationship-list: object[] @@ -121203,9 +141352,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    customers: +

    evcs: object @@ -121213,15 +141362,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of customer identifiers to provide linkage back to BSS information.

    - -
    -
    - customer: +
    + evc: object[] @@ -121231,7 +141376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - customer + evc @@ -121244,9 +141389,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cvlan-tag-entry: +

    external-system: object @@ -121254,37 +141399,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Namespace for external system.

    + +
    -
    - cvlan-tag: - integer +
    + esr-ems-list: + object -
    -

    See mis-na-virtualization-platform.yang

    -
    - -
    -
    -
    - resource-version: - string - -
    -
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    +
    + esr-ems-list + + + +
    + +
    +
    -
    - relationship-list: - object[] +
    + esr-vnfm-list: + object
    @@ -121293,7 +141437,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + esr-vnfm-list @@ -121302,26 +141446,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - -
    -
    -
    -
    -

    cvlan-tags: - object - - - -

    -
    -
    - -
    -
    -
    - cvlan-tag-entry: - object[] +
    + esr-thirdparty-sdnc-list: + object
    @@ -121330,7 +141457,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag-entry + esr-thirdparty-sdnc-list @@ -121343,9 +141470,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    dvs-switch: +

    extra-properties: object @@ -121354,81 +141481,19 @@ 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)
    +

    Extra properties for inventory item for response list

    -
    - 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: +

    extra-property: object @@ -121436,40 +141501,27 @@ 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 GenericVnfs.

    - -
    -
    - dvs-switch: - object[] +
    + property-name: + string
    -
    -
    - dvs-switch - - - -
    - -
    -
    +
    -
    +
    -

    edge-prop-names: +

    flavor: object @@ -121478,172 +141530,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Internal map to define the properties of an edge and interpret the map EdgeRules

    +

    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
    -
    - edgeLabel: +
    + flavor-id: string +
    +

    Flavor id, expected to be unique across cloud-region.

    -
    - direction: +
    + flavor-name: string +
    +

    Flavor name

    -
    - multiplicityRule: - string +
    + flavor-vcpus: + integer
    +

    Number of CPUs

    -
    - isParent: - boolean +
    + flavor-ram: + integer
    +

    Amount of memory

    -
    - usesResource: - boolean +
    + flavor-disk: + integer
    +

    Disk space

    -
    - hasDelTarget: - boolean +
    + flavor-ephemeral: + integer
    +

    Amount of ephemeral disk space

    -
    - SVC-INFRA: - boolean +
    + flavor-swap: + string
    +

    amount of swap space allocation

    -
    - SVC-INFRA-REV: +
    + flavor-is-public: boolean
    +

    whether flavor is available to all users or private to the tenant it was created in.

    -
    -
    -
    -
    -
    -
    -

    edge-tag-query-request: - object - - - -

    -
    -
    - -
    -
    -
    - edge-tag: +
    + flavor-selflink: string +
    +

    URL to endpoint where AAI can get more details

    -
    - result-detail: - string +
    + flavor-disabled: + boolean
    +

    Boolean as to whether this flavor is no longer enabled

    -
    - start-node-type: +
    + resource-version: string
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - start-node-filter: - object[] - - -
    -
    - -
    - -
    - start-node-filter - - - -
    - -
    -
    -
    -
    - include-node-filter: +
    + relationship-list: object[] @@ -121653,7 +141687,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - include-node-filter + relationship @@ -121662,8 +141696,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - secondary-filter: + + +
    +
    +
    +
    +

    flavors: + object + + + +

    +
    +
    +
    +

    Collection of openstack flavors.

    + +
    + +
    +
    +
    + flavor: object[] @@ -121673,7 +141728,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - secondary-filter + flavor @@ -121686,9 +141741,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    edge-tag-query-result: +

    forwarder: object @@ -121696,11 +141751,60 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Entity describing a sequenced segment of forwarding path

    + +
      +
    • TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
      • +
    • TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
      • +
    • TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
      • +
    • TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
      • +
    • TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
      • +
    • FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
    + +
    -
    - tagged-inventory-item-list: +
    + 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[] @@ -121710,7 +141814,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tagged-inventory-item-list + relationship @@ -121723,9 +141827,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    element-choice-set: +

    forwarder-evc: object @@ -121734,81 +141838,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This is how we would capture constraints defining allowed sets of elements.

    +

    forwarder object is an optional child object of the Configuration object.

      -
    • TO model-element (comprises element-choice-set, One2Many)
      • -
    • FROM constrained-element-set (is composed of element-choice-set)
    +
  • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    • -
    - element-choice-set-uuid: +
    + forwarder-evc-id: string
    +

    Key for forwarder-evc object

    -
    - element-choice-set-name: +
    + circuit-id: string -
    +

    Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

    -
    - cardinality: +
    + ivlan: string
    +

    Internal VLAN.

    -
    - resource-version: +
    + svlan: string
    +

    SVLAN value for ingress of egress forwarder.

    -
    - model-elements: - object[] +
    + 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.

    -
    - model-element - - - -
    - -
    -
    +
    relationship-list: @@ -121834,9 +141944,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    element-choice-sets: +

    forwarder-evcs: object @@ -121847,8 +141957,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - element-choice-set: +
    + forwarder-evc: object[] @@ -121858,7 +141968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - element-choice-set + forwarder-evc @@ -121871,30 +141981,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -
    -

    extra-properties: - object - - - -

    -
    -
    -
    -

    Extra properties for inventory item for response list

    - -
    - -
    -
    -
    -
    -
    -
    -
    +
    -

    extra-property: +

    forwarders: object @@ -121905,24 +141994,33 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - property-name: - string +
    + forwarder: + object[]
    +
    -
    +
    + forwarder + + + +
    + +
    +

    -
    +
    -

    flavor: +

    forwarding-path: object @@ -121931,155 +142029,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Openstack flavor.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    +

    Entity that describes the sequenced forwarding path between interfaces of services or resources

      -
    • FROM cloud-region (is composed of flavor)
      • -
    • FROM vserver
    +
  • 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
    • -
    - flavor-id: +
    + forwarding-path-id: string
    -

    Flavor id, expected to be unique across cloud-region.

    +

    Unique ID of this FP

    -
    - flavor-name: +
    + forwarding-path-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

    +

    Name of the FP

    -
    - flavor-swap: +
    + resource-version: 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.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - flavor-selflink: +
    + selflink: string -
    -

    URL to endpoint where AAI can get more details

    +

    the self link for this FP

    -
    - flavor-disabled: - boolean +
    + relationship-list: + object[]
    -

    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 + + + +
    + +
    +
    -
    - relationship-list: +
    + forwarders: object[] @@ -122089,7 +142123,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + forwarder @@ -122102,9 +142136,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    flavors: +

    forwarding-paths: object @@ -122112,15 +142146,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of openstack flavors.

    - -
    -
    - flavor: +
    + forwarding-path: object[] @@ -122130,7 +142160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - flavor + forwarding-path @@ -122155,27 +142185,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General purpose VNF

    -
    Default Delete Scope
    -

    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)
      • -
    • FROM virtual-data-center
      • -
    • FROM logical-link
    +
  • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • +
  • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
    • +
  • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • +
  • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
    • @@ -122753,13 +142782,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack group-assignment used to store exclusivity groups (EG).

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO tenant (Many2Many)
      • -
    • TO pserver (One2Many)
      • -
    • FROM cloud-region (is composed of group-assignment)
    +
  • 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)
    • @@ -122893,6 +142920,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -122905,13 +143075,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack image.

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO metadatum (comprises image, Many2Many)
      • -
    • FROM cloud-region (is composed of image)
      • -
    • FROM vserver
    +
  • 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
    • @@ -123217,6 +143387,158 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +
    +

    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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
      • +
    • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    + +
    + +
    +
    +
    + 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: @@ -123619,8 +143941,9 @@ 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
    +
  • 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
    • @@ -124023,20 +144346,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical interfaces, e.g., a vnic.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
      • -
    • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
      • -
    • 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)
    +
  • 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 logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • +
  • TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • +
  • TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
    • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -124308,14 +144631,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM l-interface (is composed of l3-interface-ipv4-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv4-address-list)
    +
  • 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)
    • @@ -124454,14 +144775,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM l-interface (is composed of l3-interface-ipv6-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv6-address-list)
    +
  • 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)
    • @@ -124600,24 +144919,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Generic network definition

    -
    Default Delete Scope
    -

    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
      • -
    • FROM tenant
      • -
    • FROM vf-module
    +
  • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • +
  • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • +
  • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM 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
    • @@ -125034,17 +145352,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Link aggregate interface

    -
    Default Delete Scope
    -

    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 vpls-pe (is composed of lag-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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • +
  • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • +
  • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • +
  • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
    • @@ -125198,8 +145516,8 @@ 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
    +
  • 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)
    • @@ -125295,6 +145613,240 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    create or update an existing pserver

    +
    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    update an existing pserver
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /business/connectors/connector/{resource-instance-id}

    create or update an existing connector

    +
    PATCH /business/connectors/connector/{resource-instance-id}

    update an existing connector
    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
    PUT /business/customers/customer/{global-customer-id}

    create or update an existing customer

    +
    PATCH /business/customers/customer/{global-customer-id}

    update an existing customer
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/newvces/newvce/{vnf-id2}

    create or update an existing newvce

    +
    PATCH /network/newvces/newvce/{vnf-id2}

    update an existing newvce
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/pnfs/pnf/{pnf-name}

    create or update an existing pnf

    +
    PATCH /network/pnfs/pnf/{pnf-name}

    update an existing pnf
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/vces/vce/{vnf-id}

    create or update an existing vce

    +
    PATCH /network/vces/vce/{vnf-id}

    update an existing vce
    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
    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
    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
    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
    PUT /network/vnfcs/vnfc/{vnfc-name}

    create or update an existing vnfc

    +
    PATCH /network/vnfcs/vnfc/{vnfc-name}

    update an existing vnfc
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    PUT /network/zones/zone/{zone-id}

    create or update an existing zone

    +
    PATCH /network/zones/zone/{zone-id}

    update an existing zone
    + + + + + + + + + + + + + + + + + + +
    + resource-instance-id + +

    Unique id of resource instance.

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -4838,7 +5674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /metadata
    @@ -5008,7 +5844,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadatum
    @@ -5055,7 +5891,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnectorMetadataMetadatum.json)

    @@ -5140,6 +5976,110 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -5267,7 +6207,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)

    @@ -5450,7 +6390,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /customers + /customers
    @@ -5575,7 +6515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /customer + /customer
    @@ -5622,7 +6562,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    customer object that needs to be created or updated

    +

    customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)

    @@ -5693,22 +6633,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing customer
    -

    DELETE /business/customers/customer/{global-customer-id}

    +
    update an existing customer
    +

    PATCH /business/customers/customer/{global-customer-id}

    Tags: Business
    -

    delete an existing customer

    +

    update an existing customer

    application/json application/xml

    +
    +
    +

    customer object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /customer +
    +
    +
    @@ -5738,22 +6690,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -5785,35 +6721,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/relationship-list/relationship

    +
    delete an existing customer
    +

    DELETE /business/customers/customer/{global-customer-id}

    Tags: Business
    -

    see node definition for valid relationships

    +

    delete an existing customer

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -5843,6 +6767,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -5875,22 +6815,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /business/customers/customer/{global-customer-id}/relationship-list/relationship

    Tags: Business
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -5951,19 +6903,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns service-subscriptions
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions

    +
    delete an existing relationship
    +

    DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

    Tags: Business
    -

    returns service-subscriptions

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -5992,36 +6949,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -     		query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -     		query - string - - -
    @@ -6031,29 +6958,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /service-subscriptions -
    -
    -
    - -
    default @@ -6076,17 +6980,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns service-subscription
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    +
    returns service-subscriptions
    +

    GET /business/customers/customer/{global-customer-id}/service-subscriptions

    Tags: Business
    -

    returns service-subscription

    +

    returns service-subscriptions

    @@ -6117,22 +7021,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type - -

    Value defined by orchestration to identify this service across ECOMP.

    -     		path - string - - - -
    subscriber-name @@ -6189,7 +7077,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service-subscription + /service-subscriptions
    @@ -6218,35 +7106,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing service-subscription
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    +
    returns service-subscription
    +

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    create or update an existing service-subscription

    +

    returns service-subscription

    -
    - -

    application/json application/xml -

    -
    -
    -

    service-subscription object that needs to be created or updated

    -

    -
    -
    -
    -
    - /service-subscription -
    -
    -
    -
    @@ -6291,105 +7162,27 @@ 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 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 -

    -
    -
    - - - - - - - - - - - - - - - - - - - + @@ -6409,6 +7201,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /service-subscription +
    +
    +
    + +
    default @@ -6431,17 +7246,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    +
    create or update an existing service-subscription
    +

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    see node definition for valid relationships

    +

    create or update an existing service-subscription

    @@ -6450,13 +7265,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

    +

    service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

    - /relationship + /service-subscription
    @@ -6536,23 +7351,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    +
    update an existing service-subscription
    +

    PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    delete an existing relationship

    +

    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 + subscriber-name -

    Value defined by orchestration to identify this service across ECOMP.

    +

    Subscriber name, an alternate way to retrieve a customer.

    		pathquery string -
    - resource-version + subscriber-type -

    resource-version for concurrency

    +

    Subscriber type, a way to provide VID with only the INFRA customers.

    		 query @@ -6397,7 +7190,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -6629,19 +7456,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns service-instances
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances

    +
    delete an existing service-subscription
    +

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

    Tags: Business
    -

    returns service-instances

    +

    delete an existing service-subscription

    +
    + +

    application/json application/xml +

    +
    @@ -6688,25 +7520,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - @@ -6725,29 +7543,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /service-instances -
    -
    -
    - -
    default @@ -6770,19 +7565,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns service-instance
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

    +
    see node definition for valid relationships
    +

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    Tags: Business
    -

    returns service-instance

    +

    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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -     		query - string - - -
    - subscriber-type + resource-version -

    Subscriber type, a way to provide VID with only the INFRA customers.

    +

    resource-version for concurrency

    		 query @@ -6714,6 +7531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -6827,157 +7639,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - service-instance-id - -

    Uniquely identifies this instance of a service

    -     		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 - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 - - -
    @@ -6987,29 +7648,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /service-instance -
    -
    -
    - -
    default @@ -7032,35 +7670,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    delete an existing relationship
    +

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

    Tags: Business
    -

    create or update an existing service-instance

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    service-instance object that needs to be created or updated

    -

    -
    -
    -
    -
    - /service-instance -
    -
    -
    @@ -7106,22 +7732,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - service-instance-id - -

    Uniquely identifies this instance of a service

    -     		path - string - - - -
    @@ -7153,24 +7763,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    returns service-instances
    +

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances

    Tags: Business
    -

    delete an existing service-instance

    +

    returns service-instances

    -
    - -

    application/json application/xml -

    -
    @@ -7217,26 +7822,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -7256,6 +7859,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /service-instances +
    +
    +
    + +
    default @@ -7278,17 +7904,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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 allotted-resources

    +

    returns service-instance

    @@ -7512,7 +8138,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /allotted-resources + /service-instance
    @@ -7540,17 +8166,646 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns allotted-resource
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

    +
    create or update an existing service-instance
    +

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

    Tags: Business
    -

    returns allotted-resource

    +

    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/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

    +

    +
    +
    +
    +
    + /service-instance +
    +
    +
    +
    +
    +
    - service-instance-id + subscriber-name -

    Uniquely identifies this instance of a service

    +

    Subscriber name, an alternate way to retrieve a customer.

    		pathquery string -
    - resource-version + subscriber-type -

    resource-version for concurrency

    +

    Subscriber type, a way to provide VID with only the INFRA customers.

    		 query @@ -7244,7 +7848,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + global-customer-id + +

    Global customer id used across ECOMP to uniquely identify customer.

    +     		path + string + + + +
    + service-type + +

    Value defined by orchestration to identify this service across ECOMP.

    +     		path + string + + + +
    + service-instance-id + +

    Uniquely identifies this instance of a service

    +     		path + string + + + +
    +
    + +
    +

    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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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

    @@ -7820,7 +9075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /allotted-resource + /allotted-resource
    @@ -7867,7 +9122,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    allotted-resource object that needs to be created or updated

    +

    allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

    @@ -7985,6 +9240,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing allotted-resource
    +

    PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -8145,7 +9537,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

    @@ -8668,7 +10060,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tunnel-xconnects + /tunnel-xconnects
    @@ -8992,7 +10384,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /tunnel-xconnect + /tunnel-xconnect
    @@ -9039,7 +10431,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    tunnel-xconnect object that needs to be created or updated

    +

    tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

    @@ -9174,22 +10566,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    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}

    +
    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
    -

    delete an existing tunnel-xconnect

    +

    update an existing tunnel-xconnect

    application/json application/xml

    +
    +
    +

    tunnel-xconnect object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /tunnel-xconnect +
    +
    +
    @@ -9283,22 +10687,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -9330,35 +10718,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing tunnel-xconnect

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -9452,6 +10828,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -9484,22 +10876,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -9624,19 +11028,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadata
    -

    GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata

    +
    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
    -

    returns metadata

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -9699,137 +11108,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -9841,29 +11147,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadata -
    -
    -
    - -
    default @@ -9886,17 +11169,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 metadatum

    +

    returns metadata

    @@ -9959,21 +11242,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - + + + + + + + + + + + + + +
    - subscriber-name - -

    Subscriber name, an alternate way to retrieve a customer.

    -     		query - string - - -
    - subscriber-type - -

    Subscriber type, a way to provide VID with only the INFRA customers.

    -     		query - string - - -
    - service-instance-name - -

    This field will store a name assigned to the service-instance.

    -     		query - string - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 + id -

    An identifier that customers assign to the location where this service is being used.

    +

    Allotted Resource id UUID assigned to this instance.

    		querypath string +
    - orchestration-status + id -

    Orchestration status of this service.

    +

    Allotted Resource id UUID assigned to this instance.

    		querypath string +
    - metaname - - path - string - - - -
    subscriber-name @@ -10135,7 +11403,284 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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
    @@ -10182,7 +11727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)

    @@ -10299,6 +11844,142 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -10458,7 +12139,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

    @@ -10705,7 +12386,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cloud-regions + /cloud-regions
    @@ -10846,7 +12527,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cloud-region + /cloud-region
    @@ -10893,7 +12574,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cloud-region object that needs to be created or updated

    +

    cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)

    @@ -10980,16 +12661,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing cloud-region
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

    +
    update an existing cloud-region
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

    Tags: CloudInfrastructure
    -

    delete an existing cloud-region

    +

    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

    @@ -11201,7 +12987,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /availability-zones + /availability-zones
    @@ -11358,7 +13144,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /availability-zone + /availability-zone
    @@ -11405,7 +13191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    availability-zone object that needs to be created or updated

    +

    availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

    @@ -11507,6 +13293,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -11651,7 +13558,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

    @@ -11975,7 +13882,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /dvs-switches + /dvs-switches
    @@ -12147,7 +14054,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /dvs-switch + /dvs-switch
    @@ -12194,7 +14101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    dvs-switch object that needs to be created or updated

    +

    dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

    @@ -12297,22 +14204,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing dvs-switch
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

    +
    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
    -

    delete an existing dvs-switch

    +

    update an existing dvs-switch

    application/json application/xml

    +
    +
    +

    dvs-switch object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /dvs-switch +
    +
    +
    @@ -12374,22 +14293,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -12421,35 +14324,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing dvs-switch

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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 + + + +
    + 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/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -12764,7 +14792,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /flavors + /flavors
    @@ -12936,7 +14964,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /flavor + /flavor
    @@ -12983,7 +15011,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    flavor object that needs to be created or updated

    +

    flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -13085,6 +15113,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + +
    +
    +
    update an existing flavor
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

    + 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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    +
    @@ -13229,7 +15378,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

    @@ -13553,7 +15702,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignments + /group-assignments
    @@ -13740,7 +15889,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /group-assignment + /group-assignment
    @@ -13787,7 +15936,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    group-assignment object that needs to be created or updated

    +

    group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    @@ -13890,16 +16039,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing group-assignment
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

    +
    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
    -

    delete an existing group-assignment

    +

    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

    @@ -14033,7 +16303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

    @@ -14357,7 +16627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /images + /images
    @@ -14574,7 +16844,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /image + /image
    @@ -14621,7 +16891,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    image object that needs to be created or updated

    +

    image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

    @@ -14724,22 +16994,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing image
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    +
    update an existing image
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    Tags: CloudInfrastructure
    -

    delete an existing image

    +

    update an existing image

    application/json application/xml

    +
    +
    +

    image object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /image +
    +
    +
    @@ -14801,22 +17083,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -14848,19 +17114,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns metadata
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata

    +
    delete an existing image
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

    Tags: CloudInfrastructure
    -

    returns metadata

    +

    delete an existing image

    +
    + +

    application/json application/xml +

    +
    @@ -14923,85 +17194,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -15020,29 +17217,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadata -
    -
    -
    - -
    default @@ -15065,17 +17239,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadatum
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    +
    returns metadata
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata

    Tags: CloudInfrastructure
    -

    returns metadatum

    +

    returns metadata

    @@ -15138,21 +17312,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - + + + + + + +
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - image-name - -

    Image name

    -     		query - string - - -
    - application - -

    The application that the image instantiates.

    -     		query - string - - -
    - application-vendor - -

    The vendor of the application.

    -     		query - string - - -
    - application-version + resource-version -

    The version of the application.

    +

    resource-version for concurrency

    		 query @@ -15009,6 +17205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - metaname - - path - string - - - -
    cloud-type @@ -15269,7 +17428,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadatum + /metadata
    @@ -15298,35 +17457,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    +
    -
    create or update an existing metadatum
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    +
    returns metadatum
    +

    GET /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

    +

    returns metadatum

    -
    - -

    application/json application/xml -

    -
    -
    -

    metadatum object that needs to be created or updated

    -

    -
    -
    -
    -
    - /metadatum -
    -
    -
    -
    @@ -15402,6 +17544,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + image-name + +

    Image name

    +     		query + string + + +
    + application + +

    The application that the image instantiates.

    +     		query + string + + +
    + application-vendor + +

    The vendor of the application.

    +     		query + string + + +
    + application-version + +

    The version of the application.

    +     		query + string + + +
    @@ -15411,6 +17643,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /metadatum +
    +
    +
    + +
    default @@ -15434,22 +17689,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing metadatum
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    +
    create or update an existing metadatum
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

    Tags: CloudInfrastructure
    -

    delete an existing metadatum

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

    +

    +
    +
    +
    +
    + /metadatum +
    +
    +
    @@ -15526,22 +17793,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -15573,17 +17824,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing metadatum

    @@ -15592,13 +17843,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

    +

    metadatum object that needs to be created or updated.

    - /relationship + /metadatum
    @@ -15663,6 +17914,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + metaname + + path + string + + + +
    @@ -15694,17 +17960,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing metadatum

    @@ -15772,6 +18038,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + metaname + + path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -15803,17 +18100,247 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns oam-networks
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks

    +
    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
    -

    returns oam-networks

    +

    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/v9/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

    @@ -15916,7 +18443,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /oam-networks + /oam-networks
    @@ -16103,7 +18630,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /oam-network + /oam-network
    @@ -16150,7 +18677,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    oam-network object that needs to be created or updated

    +

    oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

    @@ -16253,22 +18780,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing oam-network
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

    +
    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
    -

    delete an existing oam-network

    +

    update an existing oam-network

    application/json application/xml

    +
    +
    +

    oam-network object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /oam-network +
    +
    +
    @@ -16330,22 +18869,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -16377,35 +18900,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing oam-network

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -16467,6 +18978,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -16499,22 +19026,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -16607,35 +19146,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -16681,6 +19208,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + network-uuid + +

    UUID of the network. Unique across a cloud-region

    +     		path + string + + + +
    @@ -16713,22 +19256,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -16805,19 +19360,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns snapshots
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns snapshots

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -16862,36 +19422,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    @@ -16901,29 +19431,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /snapshots -
    -
    -
    - -
    default @@ -16946,17 +19453,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns snapshot
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    returns snapshots
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots

    Tags: CloudInfrastructure
    -

    returns snapshot

    +

    returns snapshots

    @@ -17003,22 +19510,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - snapshot-id - -

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    -     		path - string - - - -
    cloud-type @@ -17049,81 +19540,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -17150,7 +19566,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /snapshot + /snapshots
    @@ -17179,35 +19595,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -
    create or update an existing snapshot
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    +
    returns snapshot
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    create or update an existing snapshot

    +

    returns snapshot

    -
    - -

    application/json application/xml -

    -
    -
    -

    snapshot object that needs to be created or updated

    -

    -
    -
    -
    -
    - /snapshot -
    -
    -
    -
    @@ -17268,121 +19667,102 @@ 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 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 -

    -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + + @@ -17402,6 +19781,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /snapshot +
    +
    +
    + +
    default @@ -17424,17 +19826,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    +
    create or update an existing snapshot
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    create or update an existing snapshot

    @@ -17443,13 +19845,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

    +

    snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    - /relationship + /snapshot
    @@ -17545,23 +19947,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

    +
    update an existing snapshot
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    update an existing snapshot

    application/json application/xml

    +
    +
    +

    snapshot object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /snapshot +
    +
    +
    - cloud-owner + cloud-type -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - cloud-region-id + owner-defined-type -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		pathquery string -
    - snapshot-id + snapshot-name -

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    +

    Snapshot name

    		pathquery string -
    - resource-version + application -

    resource-version for concurrency

    +

    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 @@ -17390,7 +19770,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -17654,19 +20068,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns tenants
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

    +
    delete an existing snapshot
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

    Tags: CloudInfrastructure
    -

    returns tenants

    +

    delete an existing snapshot

    +
    + +

    application/json application/xml +

    +
    @@ -17713,25 +20132,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -17750,29 +20171,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /tenants -
    -
    -
    - -
    default @@ -17795,19 +20193,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns tenant
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    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
    -

    returns tenant

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - cloud-type + snapshot-id -

    Type of the cloud (e.g., openstack)

    +

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    		querypath string +
    - owner-defined-type + resource-version -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    resource-version for concurrency

    		 query @@ -17739,6 +20159,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -17854,10 +20269,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - tenant-id + snapshot-id -

    Unique id relative to the cloud-region.

    +

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    		 path @@ -17868,51 +20283,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    @@ -17922,29 +20292,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /tenant -
    -
    -
    - -
    default @@ -17967,35 +20314,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing tenant
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    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
    -

    create or update an existing tenant

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    tenant object that needs to be created or updated

    -

    -
    -
    -
    -
    - /tenant -
    -
    -
    @@ -18043,10 +20378,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - tenant-id + snapshot-id -

    Unique id relative to the cloud-region.

    +

    Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

    		 path @@ -18088,24 +20423,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing tenant
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    +
    returns tenants
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

    Tags: CloudInfrastructure
    -

    delete an existing tenant

    +

    returns tenants

    -
    - -

    application/json application/xml -

    -
    @@ -18152,26 +20482,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -18191,6 +20519,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /tenants +
    +
    +
    + +
    default @@ -18213,36 +20564,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    +
    returns tenant
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    returns tenant

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    - tenant-id + cloud-type -

    Unique id relative to the cloud-region.

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - resource-version + owner-defined-type -

    resource-version for concurrency

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		 query @@ -18179,7 +20508,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -18303,6 +20637,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + tenant-name + +

    Readable name of tenant

    +     		query + string + + +
    @@ -18312,6 +20691,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /tenant +
    +
    +
    + +
    default @@ -18334,23 +20736,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

    +
    create or update an existing tenant
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    +

    +
    +
    +
    +
    + /tenant +
    +
    +
    @@ -18443,19 +20857,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vservers
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

    +
    update an existing tenant
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    returns vservers

    +

    update an existing tenant

    +
    + +

    application/json application/xml +

    +
    +
    +

    tenant object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /tenant +
    +
    +
    +
    @@ -18516,51 +20947,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    @@ -18570,29 +20956,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vservers -
    -
    -
    - -
    default @@ -18615,19 +20978,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vserver
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    delete an existing tenant
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

    Tags: CloudInfrastructure
    -

    returns vserver

    +

    delete an existing tenant

    +
    + +

    application/json application/xml +

    +
    @@ -18690,56 +21058,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - + +
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -     		path - string - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name + resource-version -

    Readable name of tenant

    +

    resource-version for concurrency

    		 query @@ -18747,79 +21069,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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - @@ -18831,29 +21202,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vserver -
    -
    -
    - -
    default @@ -18876,35 +21224,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vserver
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    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
    -

    create or update an existing vserver

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    vserver object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vserver -
    -
    -
    - vserver-name + cloud-owner -

    Name of vserver

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		querypath string +
    - vserver-name2 + cloud-region-id -

    Alternative name of vserver

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - prov-status + tenant-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id relative to the cloud-region.

    		querypath string -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - +
    @@ -18966,22 +21302,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -     		path - string - - - -
    @@ -19013,24 +21333,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vserver
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

    +
    returns vservers
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

    Tags: CloudInfrastructure
    -

    delete an existing vserver

    +

    returns vservers

    -
    - -

    application/json application/xml -

    -
    @@ -19093,26 +21408,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -19132,6 +21460,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vservers +
    +
    +
    + +
    default @@ -19154,17 +21505,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

    +
    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 l-interfaces

    +

    returns vserver

    @@ -19387,7 +21738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /vserver
    @@ -19415,19 +21766,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    returns l-interface

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    +

    +
    +
    +
    +
    + /vserver +
    +
    +
    +
    - vserver-id + cloud-type -

    Unique identifier for this vserver relative to its tenant

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - resource-version + owner-defined-type -

    resource-version for concurrency

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + tenant-name + +

    Readable name of tenant

    		 query @@ -19120,7 +21449,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -19504,12 +21872,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -19692,29 +22018,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interface -
    -
    -
    - -
    default @@ -19737,35 +22040,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    create or update an existing l-interface

    +

    delete an existing vserver

    application/json application/xml

    -
    -
    -

    l-interface object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l-interface -
    -
    -
    - interface-name + cloud-owner -

    Name given to the interface

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -19522,165 +21963,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id + cloud-region-id -

    ID of interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - macaddr + tenant-id -

    MAC address for the interface

    +

    Unique id relative to the cloud-region.

    		querypath string +
    - network-name + vserver-id -

    Name of the network

    +

    Unique identifier for this vserver relative to its tenant

    		querypath string +
    @@ -19845,12 +22136,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
    - interface-name + resource-version -

    Name given to the interface

    +

    resource-version for concurrency

    		pathquery string @@ -19890,24 +22181,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

    +
    returns 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
    -

    delete an existing l-interface

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -19986,26 +22272,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -20025,6 +22397,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interfaces +
    +
    +
    + +
    default @@ -20047,17 +22442,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/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 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 l3-interface-ipv4-address-list

    +

    returns l-interface

    @@ -20152,22 +22547,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name + cloud-type -

    Name given to the interface

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - resource-version + owner-defined-type -

    resource-version for concurrency

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		 query @@ -20013,7 +22298,94 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    + tenant-name + +

    Readable name of tenant

    +     		query + string + + +
    + vserver-name + +

    Name of vserver

    +     		query + string + + +
    + vserver-name2 + +

    Alternative name of vserver

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + +
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    cloud-type @@ -20331,51 +22710,6 @@ 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 - -

    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 - - -
    @@ -20402,7 +22736,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l-interface
    @@ -20430,17 +22764,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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 l3-interface-ipv4-address-list

    +

    create or update an existing l-interface

    @@ -20449,13 +22783,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

    - /l3-interface-ipv4-address-list + /l-interface
    @@ -20552,22 +22886,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -20599,190 +22917,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    -
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/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

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l-interface

    @@ -20791,13 +22936,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

    +

    l-interface object that needs to be created or updated.

    - /relationship + /l-interface
    @@ -20894,22 +23039,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -20941,17 +23070,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l-interface

    @@ -21053,12 +23182,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -21098,17 +23227,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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-ipv6-address-list

    +

    returns l3-interface-ipv4-address-list

    @@ -21205,7 +23334,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -21453,7 +23582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -21481,17 +23610,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -21500,13 +23629,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -21605,7 +23734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -21650,23 +23779,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -21762,7 +23903,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -21776,22 +23917,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -21823,35 +23948,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -21947,7 +24060,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -21961,6 +24074,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -21992,23 +24121,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -22104,7 +24245,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -22149,35 +24290,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -22271,137 +24400,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/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 + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -22443,17 +24447,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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 sriov-vfs

    +

    returns l3-interface-ipv6-address-list

    @@ -22548,6 +24552,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    cloud-type @@ -22711,6 +24731,51 @@ 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 + +

    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 + + +
    @@ -22737,7 +24802,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /l3-interface-ipv6-address-list
    @@ -22765,19 +24830,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    returns sriov-vf

    +

    create or update an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    @@ -22872,10 +24954,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -22886,229 +24968,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - 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 - - -
    @@ -23118,29 +24977,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vf -
    -
    -
    - -
    default @@ -23163,17 +24999,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing sriov-vf
    -

    PUT /cloud-infrastructure/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 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
    -

    create or update an existing sriov-vf

    +

    update an existing l3-interface-ipv6-address-list

    @@ -23182,13 +25018,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -23287,10 +25123,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -23332,17 +25168,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -23444,10 +25280,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -23505,11 +25341,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -23524,7 +25360,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -23629,10 +25465,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -23674,11 +25510,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/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
    @@ -23786,10 +25622,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + l3-interface-ipv6-address -

    PCI ID used to identify the sriov-vf

    +

    IP address

    		 path @@ -23831,19 +25667,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -23936,167 +25789,145 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - + - + - + @@ -24108,29 +25939,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -24153,17 +25961,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    returns sriov-vfs

    @@ -24258,22 +26066,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - -
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 + cloud-owner -

    Alternative name of vserver

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		querypath string +
    - prov-status + cloud-region-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id + tenant-id -

    ID of interface

    +

    Unique id relative to the cloud-region.

    		querypath string +
    - macaddr + vserver-id -

    MAC address for the interface

    +

    Unique identifier for this vserver relative to its tenant

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name given to the interface

    		querypath string +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    cloud-type @@ -24437,36 +26229,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -24493,7 +26255,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /sriov-vfs
    @@ -24521,36 +26283,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-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 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
    -

    create or update an existing vlan

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    vlan object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vlan -
    -
    -
    -
    @@ -24645,10 +26390,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vlan-interface + pci-id -

    String that identifies the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -24659,169 +26404,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing vlan
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -24841,6 +26636,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -24863,19 +26681,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    - cloud-owner + cloud-type -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - cloud-region-id + owner-defined-type -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		pathquery string -
    - tenant-id + tenant-name -

    Unique id relative to the cloud-region.

    +

    Readable name of tenant

    		pathquery string -
    - vserver-id + vserver-name -

    Unique identifier for this vserver relative to its tenant

    +

    Name of vserver

    		pathquery string -
    - interface-name + vserver-name2 -

    Name given to the interface

    +

    Alternative name of vserver

    		pathquery string -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - resource-version + in-maint -

    resource-version for concurrency

    +     		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 @@ -24829,7 +26625,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -24970,26 +26805,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -25000,244 +26819,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 - -

    Alternative name of vserver

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -     		query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -     		query - string - - -
    @@ -25247,29 +26828,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -25292,17 +26850,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    update an existing sriov-vf

    @@ -25311,13 +26869,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

    +

    sriov-vf object that needs to be created or updated.

    - /l3-interface-ipv4-address-list + /sriov-vf
    @@ -25416,26 +26974,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -25477,17 +27019,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-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 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 l3-interface-ipv4-address-list

    +

    delete an existing sriov-vf

    @@ -25589,26 +27131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -25666,11 +27192,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -25685,7 +27211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -25790,26 +27316,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -25851,11 +27361,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
    @@ -25963,26 +27473,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -26024,17 +27518,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns 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 l3-interface-ipv6-address-list

    +

    returns vlans

    @@ -26129,38 +27623,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    cloud-type @@ -26324,81 +27786,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    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 - - -
    @@ -26425,7 +27812,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /vlans
    @@ -26453,36 +27840,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns vlan
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -26593,199 +27963,188 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - l3-interface-ipv6-address + cloud-type -

    IP address

    +

    Type of the cloud (e.g., openstack)

    		pathquery 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + - + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + @@ -26805,6 +28163,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    default @@ -26827,17 +28208,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing vlan

    @@ -26846,13 +28227,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

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    - /relationship + /vlan
    @@ -26965,22 +28346,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - -
    - cloud-owner + owner-defined-type -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		pathquery string -
    - cloud-region-id + tenant-name -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Readable name of tenant

    		pathquery string -
    - tenant-id + vserver-name -

    Unique id relative to the cloud-region.

    +

    Name of vserver

    		pathquery string -
    - vserver-id + vserver-name2 -

    Unique identifier for this vserver relative to its tenant

    +

    Alternative name of vserver

    		pathquery string -
    - interface-name + prov-status -

    Name given to the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - vlan-interface + in-maint -

    String that identifies the interface

    		pathquery + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + interface-id + +

    ID of interface

    +     		query string -
    - l3-interface-ipv6-address + macaddr -

    IP address

    +

    MAC address for the interface

    		pathquery string -
    - resource-version + network-name -

    resource-version for concurrency

    +

    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 @@ -26793,7 +28152,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -27012,23 +28377,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing vlan
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -27138,22 +28515,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -27185,35 +28546,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -27323,6 +28672,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -27354,24 +28719,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    returns l3-interface-ipv4-address-list
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -27480,117 +28840,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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

    -

    -
    -
    -
    -
    - /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 + l3-interface-ipv4-address -

    Unique id relative to the cloud-region.

    +

    IP address

    		 path @@ -27603,271 +28858,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vserver-id - -

    Unique identifier for this vserver relative to its tenant

    -     		path - string - - - -
    -
    - -
    -

    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 + cloud-type -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - cloud-region-id + owner-defined-type -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		pathquery string -
    - tenant-id + tenant-name -

    Unique id relative to the cloud-region.

    +

    Readable name of tenant

    		pathquery string -
    - vserver-id + vserver-name -

    Unique identifier for this vserver relative to its tenant

    +

    Name of vserver

    		pathquery 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 + vserver-name2 -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Alternative name of vserver

    		pathquery string -
    - cloud-region-id + prov-status -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - tenant-id + in-maint -

    Unique id relative to the cloud-region.

    		pathquery - string + boolean -
    - vserver-id + is-closed-loop-disabled -

    Unique identifier for this vserver relative to its tenant

    		pathquery - string + boolean -
    - cloud-type + interface-id -

    Type of the cloud (e.g., openstack)

    +

    ID of interface

    		 query @@ -27879,10 +28991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - owner-defined-type + macaddr -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    MAC address for the interface

    		 query @@ -27894,10 +29006,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant-name + network-name -

    Readable name of tenant

    +

    Name of the network

    		 query @@ -27909,14 +29021,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vserver-name + vlan-id-inner -

    Name of vserver

    +

    Inner VLAN tag

    		 query - string + integer @@ -27924,10 +29036,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vserver-name2 + vpn-id -

    Alternative name of vserver

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -27939,14 +29051,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vlan-id-inner -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Inner VLAN tag

    		 query - string + integer @@ -27954,13 +29066,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + neutron-network-id +

    Neutron network id of the interface that address belongs to

    		 query - boolean + string @@ -27968,13 +29081,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + neutron-subnet-id +

    Neutron id of subnet that address belongs to

    		 query - boolean + string @@ -28006,7 +29120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volumes + /l3-interface-ipv4-address-list
    @@ -28034,19 +29148,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns volume
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: CloudInfrastructure
    -

    returns volume

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    @@ -28125,10 +29256,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - @@ -28266,29 +29311,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /volume -
    -
    -
    - -
    default @@ -28311,17 +29333,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing volume
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    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
    -

    create or update an existing volume

    +

    update an existing l3-interface-ipv4-address-list

    @@ -28330,13 +29352,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    - /volume + /l3-interface-ipv4-address-list
    @@ -28419,10 +29441,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - -
    - volume-id + interface-name -

    Unique ID of block storage volume relative to the vserver.

    +

    Name given to the interface

    		 path @@ -28141,120 +29272,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type - -

    Type of the cloud (e.g., openstack)

    -     		query - string - - -
    - owner-defined-type - -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -     		query - string - - -
    - tenant-name - -

    Readable name of tenant

    -     		query - string - - -
    - vserver-name - -

    Name of vserver

    -     		query - string - - -
    - vserver-name2 + vlan-interface -

    Alternative name of vserver

    +

    String that identifies the interface

    		querypath string +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    IP address

    		querypath string -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - +
    - volume-id + interface-name -

    Unique ID of block storage volume relative to the vserver.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -28464,17 +29518,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing volume
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    +
    delete an existing 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 volume

    +

    delete an existing l3-interface-ipv4-address-list

    @@ -28560,10 +29614,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-id + interface-name -

    Unique ID of block storage volume relative to the vserver.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -28621,11 +29707,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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
    @@ -28640,7 +29726,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -28729,10 +29815,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-id + interface-name -

    Unique ID of block storage volume relative to the vserver.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -28774,11 +29892,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/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
    @@ -28870,10 +29988,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-id + interface-name -

    Unique ID of block storage volume relative to the vserver.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -28915,17 +30065,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns volume-groups
    -

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

    +
    returns 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 volume-groups

    +

    returns l3-interface-ipv6-address-list

    @@ -28974,119 +30124,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-type + tenant-id -

    Type of the cloud (e.g., openstack)

    +

    Unique id relative to the cloud-region.

    		querypath string +
    - owner-defined-type + vserver-id -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +

    Unique identifier for this vserver relative to its tenant

    		querypath 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 + interface-name -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Name given to the interface

    		 path @@ -29099,10 +30172,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region-id + vlan-interface -

    Identifier used by the vendor for the region. Second part of composite key

    +

    String that identifies the interface

    		 path @@ -29115,10 +30188,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group-id + l3-interface-ipv6-address -

    Unique ID of volume-group.

    +

    IP address

    		 path @@ -29161,10 +30234,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group-name + tenant-name -

    Name of the volume group.

    +

    Readable name of tenant

    		 query @@ -29176,10 +30249,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vserver-name -

    Heat stack id corresponding to this volume-group

    +

    Name of vserver

    		 query @@ -29191,10 +30264,173 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + vserver-name2 -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Alternative name of vserver

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    +     		query + string + + +
    + neutron-subnet-id + +

    Neutron id of subnet that address belongs to

    		 query @@ -29230,7 +30466,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /volume-group + /l3-interface-ipv6-address-list
    @@ -29258,17 +30494,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing volume-group
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    +
    create or update an existing 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 volume-group

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -29277,13 +30513,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    volume-group object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /volume-group + /l3-interface-ipv6-address-list
    @@ -29334,10 +30570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group-id + tenant-id -

    Unique ID of volume-group.

    +

    Unique id relative to the cloud-region.

    		 path @@ -29348,73 +30584,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + vserver-id -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    +

    Unique identifier for this vserver relative to its tenant

    		 path @@ -29427,10 +30602,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region-id + interface-name -

    Identifier used by the vendor for the region. Second part of composite key

    +

    Name given to the interface

    		 path @@ -29443,10 +30618,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group-id + vlan-interface -

    Unique ID of volume-group.

    +

    String that identifies the interface

    		 path @@ -29459,12 +30634,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -29504,17 +30679,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -29523,13 +30698,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -29580,10 +30755,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group-id + tenant-id -

    Unique ID of volume-group.

    +

    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 @@ -29625,17 +30864,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -29689,10 +30928,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group-id + tenant-id -

    Unique ID of volume-group.

    +

    Unique id relative to the cloud-region.

    		 path @@ -29703,132 +30942,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - - + - + + + + + + + + @@ -29893,29 +31031,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /complex -
    -
    -
    - -
    default @@ -29938,17 +31053,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing complex
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

    +
    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
    -

    create or update an existing complex

    +

    see node definition for valid relationships

    @@ -29957,13 +31072,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    complex object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /complex + /relationship
    @@ -29982,10 +31097,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    - physical-location-id + vserver-id -

    Unique identifier for physical location, e.g., CLLI

    +

    Unique identifier for this vserver relative to its tenant

    		 path @@ -29841,40 +30960,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code + interface-name -

    Data center code which can be an alternate way to identify a complex

    +

    Name given to the interface

    		querypath string +
    - complex-name + vlan-interface -

    Gamma complex name for LCP instance.

    +

    String that identifies the interface

    		querypath string +
    - identity-url + l3-interface-ipv6-address -

    URL of the keystone identity service

    +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -29882,6 +31019,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -29996,73 +31111,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing complex
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing complex

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - physical-location-id + cloud-region-id -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -30075,12 +31129,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + tenant-id -

    resource-version for concurrency

    +

    Unique id relative to the cloud-region.

    		querypath string @@ -30089,68 +31143,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns ctag-pools
    -

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns ctag-pools

    - -
    -
    - - - - - - - - - - - - + - + - + @@ -30215,29 +31216,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /ctag-pools -
    -
    -
    - -
    default @@ -30260,19 +31238,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns ctag-pool
    -

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    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
    -

    returns ctag-pool

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - physical-location-id + vserver-id -

    Unique identifier for physical location, e.g., CLLI

    +

    Unique identifier for this vserver relative to its tenant

    		 path @@ -30163,47 +31161,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code + interface-name -

    Data center code which can be an alternate way to identify a complex

    +

    Name given to the interface

    		querypath string +
    - complex-name + vlan-interface -

    Gamma complex name for LCP instance.

    +

    String that identifies the interface

    		querypath string +
    - identity-url + l3-interface-ipv6-address -

    URL of the keystone identity service

    +

    IP address

    		querypath string +
    @@ -30287,10 +31270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -30387,29 +31389,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /ctag-pool -
    -
    -
    - -
    default @@ -30432,17 +31411,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing ctag-pool
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    create or update an existing ctag-pool

    +

    see node definition for valid relationships

    @@ -30451,13 +31430,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-pool object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

    - /ctag-pool + /relationship
    @@ -30476,10 +31455,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -30303,10 +31286,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe + cloud-region-id -

    The Target provider edge router

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -30319,10 +31302,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone-name + tenant-id -

    Name of the availability zone

    +

    Unique id relative to the cloud-region.

    		 path @@ -30335,47 +31318,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - data-center-code + vserver-id -

    Data center code which can be an alternate way to identify a complex

    +

    Unique identifier for this vserver relative to its tenant

    		querypath string +
    - complex-name + interface-name -

    Gamma complex name for LCP instance.

    +

    Name given to the interface

    		querypath string +
    - identity-url + vlan-interface -

    URL of the keystone identity service

    +

    String that identifies the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string +
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -30492,10 +31471,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe + cloud-region-id -

    The Target provider edge router

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -30508,10 +31487,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone-name + tenant-id -

    Name of the availability zone

    +

    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 @@ -30553,17 +31580,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing ctag-pool
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    +
    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 ctag-pool

    +

    delete an existing relationship

    @@ -30585,10 +31612,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -30601,10 +31628,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe + cloud-region-id -

    The Target provider edge router

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -30617,10 +31644,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone-name + tenant-id -

    Name of the availability zone

    +

    Unique id relative to the cloud-region.

    		 path @@ -30633,12 +31660,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vserver-id -

    resource-version for concurrency

    +

    Unique identifier for this vserver relative to its tenant

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string @@ -30678,11 +31737,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

    +

    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
    @@ -30697,7 +31756,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

    @@ -30722,10 +31781,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -30738,10 +31797,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe + cloud-region-id -

    The Target provider edge router

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -30754,10 +31813,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone-name + tenant-id -

    Name of the availability zone

    +

    Unique id relative to the cloud-region.

    +     		path + string + + + +
    + vserver-id + +

    Unique identifier for this vserver relative to its tenant

    		 path @@ -30799,11 +31874,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

    +

    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
    @@ -30831,10 +31906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -30847,10 +31922,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - target-pe + cloud-region-id -

    The Target provider edge router

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -30863,10 +31938,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone-name + tenant-id -

    Name of the availability zone

    +

    Unique id relative to the cloud-region.

    +     		path + string + + + +
    + vserver-id + +

    Unique identifier for this vserver relative to its tenant

    		 path @@ -30908,36 +31999,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

    +
    returns volumes
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    returns volumes

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -30952,10 +32026,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    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 @@ -30966,6 +32088,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + tenant-name + +

    Readable name of tenant

    +     		query + string + + +
    + vserver-name + +

    Name of vserver

    +     		query + string + + +
    + vserver-name2 + +

    Alternative name of vserver

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    @@ -30975,6 +32215,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /volumes +
    +
    +
    + +
    default @@ -30997,24 +32260,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

    +
    returns volume
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    returns volume

    -
    - -

    application/json application/xml -

    -
    @@ -31029,10 +32287,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - physical-location-id + cloud-owner -

    Unique identifier for physical location, e.g., CLLI

    +

    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 @@ -31043,51 +32365,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cloud-type + +

    Type of the cloud (e.g., openstack)

    +     		query + string + + +
    + owner-defined-type + +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    +     		query + string + + +
    + tenant-name + +

    Readable name of tenant

    +     		query + string + + +
    + vserver-name + +

    Name of vserver

    +     		query + string + + +
    + vserver-name2 + +

    Alternative name of vserver

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    -
    -

    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

    @@ -31110,7 +32509,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /network-profiles + /volume
    @@ -31138,19 +32537,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns network-profile
    -

    GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    +
    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
    -

    returns network-profile

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    +

    +
    +
    +
    +
    + /volume +
    +
    +
    +
    @@ -31165,10 +32581,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - nm-profile-name + cloud-owner -

    Unique name of network profile.

    +

    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 @@ -31188,29 +32668,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /network-profile -
    -
    -
    - -
    default @@ -31233,17 +32690,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing network-profile
    -

    PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    +
    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
    -

    create or update an existing network-profile

    +

    update an existing volume

    @@ -31252,13 +32709,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-profile object that needs to be created or updated

    +

    volume object that needs to be created or updated.

    - /network-profile + /volume
    @@ -31277,10 +32734,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nm-profile-name + cloud-owner -

    Unique name of network profile.

    +

    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 @@ -31322,17 +32843,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing network-profile
    -

    DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    +
    delete an existing 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 network-profile

    +

    delete an existing volume

    @@ -31354,10 +32875,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nm-profile-name + cloud-owner -

    Unique name of network profile.

    +

    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 @@ -31415,11 +33000,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -31434,7 +33019,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

    @@ -31459,10 +33044,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nm-profile-name + cloud-owner -

    Unique name of network profile.

    +

    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 @@ -31504,11 +33153,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -31536,10 +33185,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - nm-profile-name + cloud-owner -

    Unique name of network profile.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -31550,79 +33199,79 @@ 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 pservers
    -

    GET /cloud-infrastructure/pservers

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns pservers

    - -
    +
    + 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

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /pservers -
    -
    -
    - -
    default @@ -31645,17 +33294,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns pserver
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}

    +
    returns volume-groups
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

    Tags: CloudInfrastructure
    -

    returns pserver

    +

    returns volume-groups

    @@ -31672,10 +33321,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname + cloud-owner -

    Value from executing hostname on the compute node.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -31688,25 +33337,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + cloud-region-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - pserver-id + cloud-type -

    ID of Pserver

    +

    Type of the cloud (e.g., openstack)

    		 query @@ -31718,24 +33368,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint - - query - boolean - - -
    - pserver-name2 + owner-defined-type -

    alternative pserver name

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		 query @@ -31771,7 +33407,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /pserver + /volume-groups
    @@ -31799,36 +33435,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing pserver
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    +
    returns volume-group
    +

    GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

    Tags: CloudInfrastructure
    -

    create or update an existing pserver

    +

    returns volume-group

    -
    - -

    application/json application/xml -

    -
    -
    -

    pserver object that needs to be created or updated

    -

    -
    -
    -
    -
    - /pserver -
    -
    -
    -
    @@ -31843,10 +33462,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - hostname + cloud-owner -

    Value from executing hostname on the compute node.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -31857,73 +33476,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing pserver
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing pserver

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - hostname + cloud-region-id -

    Value from executing hostname on the compute node.

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -31936,12 +33494,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + volume-group-id -

    resource-version for concurrency

    +

    Unique ID of volume-group.

    		querypath string @@ -31950,84 +33508,27 @@ 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 lag-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

    - Tags: - CloudInfrastructure -
    -
    -
    -

    returns lag-interfaces

    - -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - -
    - hostname + cloud-type -

    Value from executing hostname on the compute node.

    +

    Type of the cloud (e.g., openstack)

    		pathquery string -
    - inv-status + owner-defined-type -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    		 query @@ -32039,10 +33540,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + volume-group-name -

    ID of Pserver

    +

    Name of the volume group.

    		 query @@ -32054,13 +33555,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + heat-stack-id +

    Heat stack id corresponding to this volume-group

    		 query - boolean + string @@ -32068,10 +33570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-name2 + vnf-type -

    alternative pserver name

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		 query @@ -32107,7 +33609,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /volume-group
    @@ -32135,19 +33637,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    +
    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
    -

    returns lag-interface

    +

    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/v9/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    +

    +
    +
    +
    +
    + /volume-group +
    +
    +
    +
    @@ -32162,10 +33681,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -32290,29 +33736,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /lag-interface -
    -
    -
    - -
    default @@ -32335,17 +33758,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing lag-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    +
    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
    -

    create or update an existing lag-interface

    +

    update an existing volume-group

    @@ -32354,13 +33777,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

    +

    volume-group object that needs to be created or updated.

    - /lag-interface + /volume-group
    @@ -32379,10 +33802,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - hostname + cloud-owner -

    Value from executing hostname on the compute node.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -32178,10 +33697,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + cloud-region-id -

    Name that identifies the link aggregate interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -32194,91 +33713,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role + volume-group-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Unique ID of volume-group.

    		querypath string +
    - hostname + cloud-owner -

    Value from executing hostname on the compute node.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -32395,10 +33818,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + cloud-region-id -

    Name that identifies the link aggregate interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + volume-group-id + +

    Unique ID of volume-group.

    		 path @@ -32440,17 +33879,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing lag-interface
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    +
    delete an existing 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 lag-interface

    +

    delete an existing volume-group

    @@ -32472,10 +33911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname + cloud-owner -

    Value from executing hostname on the compute node.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -32488,10 +33927,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + cloud-region-id -

    Name that identifies the link aggregate interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    +     		path + string + + + +
    + volume-group-id + +

    Unique ID of volume-group.

    		 path @@ -32549,19 +34004,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns l-interfaces

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -32576,10 +34048,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + +
    - hostname + cloud-owner -

    Value from executing hostname on the compute node.

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		 path @@ -32592,10 +34064,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + cloud-region-id -

    Name that identifies the link aggregate interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    		 path @@ -32608,97 +34080,174 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id + volume-group-id -

    ID of Pserver

    +

    Unique ID of volume-group.

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - + - + - +
    - in-maint - - query - boolean - - -
    - pserver-name2 + cloud-owner -

    alternative pserver name

    +

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    		querypath string +
    - interface-id + cloud-region-id -

    ID of interface

    +

    Identifier used by the vendor for the region. Second part of composite key

    		querypath string +
    - interface-role + volume-group-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Unique ID of volume-group.

    		querypath 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

    @@ -32721,7 +34270,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /complexes
    @@ -32749,17 +34298,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns complex
    +

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    returns l-interface

    +

    returns complex

    @@ -32776,42 +34325,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name given to the interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -32824,99 +34341,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id + data-center-code -

    ID of interface

    +

    Data center code which can be an alternate way to identify a complex

    		 query @@ -32928,10 +34356,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + complex-name -

    MAC address for the interface

    +

    Gamma complex name for LCP instance.

    		 query @@ -32943,10 +34371,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + identity-url -

    Name of the network

    +

    URL of the keystone identity service

    		 query @@ -32982,7 +34410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /complex
    @@ -33010,17 +34438,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    create or update an existing complex
    +

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    create or update an existing l-interface

    +

    create or update an existing complex

    @@ -33029,13 +34457,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

    +

    complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplex.json)

    - /l-interface + /complex
    @@ -33054,42 +34482,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name given to the interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -33131,23 +34527,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    update an existing complex
    +

    PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    delete an existing l-interface

    +

    update an existing complex

    application/json application/xml

    +
    +
    +

    complex object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /complex +
    +
    +
    @@ -33163,42 +34571,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name given to the interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -33209,22 +34585,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -33256,19 +34616,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    delete an existing complex
    +

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing complex

    +
    + +

    application/json application/xml +

    +
    @@ -33283,10 +34648,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - hostname + physical-location-id -

    Value from executing hostname on the compute node.

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -33299,12 +34664,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-version -

    Name that identifies the link aggregate interface

    +

    resource-version for concurrency

    		pathquery string @@ -33313,217 +34678,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    - 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 - - -
    @@ -33533,29 +34687,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -33578,36 +34709,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /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 ctag-pools
    +

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

    Tags: CloudInfrastructure
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns ctag-pools

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -33622,10 +34736,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -33693,6 +34804,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /ctag-pools +
    +
    +
    + +
    default @@ -33715,24 +34849,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns ctag-pool
    +

    GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    Tags: CloudInfrastructure
    -

    delete an existing l3-interface-ipv4-address-list

    +

    returns ctag-pool

    -
    - -

    application/json application/xml -

    -
    - hostname + physical-location-id -

    Value from executing hostname on the compute node.

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -33638,50 +34752,47 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + data-center-code -

    Name that identifies the link aggregate interface

    +

    Data center code which can be an alternate way to identify a complex

    		pathquery string -
    - interface-name + complex-name -

    Name given to the interface

    +

    Gamma complex name for LCP instance.

    		pathquery string -
    - l3-interface-ipv4-address + identity-url -

    IP address

    +

    URL of the keystone identity service

    		pathquery string -
    @@ -33747,10 +34876,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -33834,6 +34976,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /ctag-pool +
    +
    +
    + +
    default @@ -33856,17 +35021,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    create or update an existing ctag-pool
    +

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    create or update an existing ctag-pool

    @@ -33875,13 +35040,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

    +

    ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

    - /relationship + /ctag-pool
    @@ -33900,26 +35065,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - + + + + + + +
    - hostname + physical-location-id -

    Value from executing hostname on the compute node.

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -33763,10 +34892,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + target-pe -

    Name that identifies the link aggregate interface

    +

    The Target provider edge router

    		 path @@ -33779,10 +34908,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + availability-zone-name -

    Name given to the interface

    +

    Name of the availability zone

    		 path @@ -33795,26 +34924,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + data-center-code -

    IP address

    +

    Data center code which can be an alternate way to identify a complex

    		pathquery string -
    - resource-version + complex-name -

    resource-version for concurrency

    +

    Gamma complex name for LCP instance.

    +     		query + string + + +
    + identity-url + +

    URL of the keystone identity service

    		 query @@ -33822,7 +34965,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name that identifies the link aggregate interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -33932,10 +35081,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + target-pe -

    Name given to the interface

    +

    The Target provider edge router

    		 path @@ -33948,10 +35097,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + availability-zone-name -

    IP address

    +

    Name of the availability zone

    		 path @@ -33993,23 +35142,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing ctag-pool
    +

    PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    update an existing ctag-pool

    application/json application/xml

    +
    +
    +

    ctag-pool object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /ctag-pool +
    +
    +
    @@ -34025,26 +35186,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name that identifies the link aggregate interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -34057,10 +35202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + target-pe -

    Name given to the interface

    +

    The Target provider edge router

    		 path @@ -34073,10 +35218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + availability-zone-name -

    IP address

    +

    Name of the availability zone

    		 path @@ -34118,19 +35263,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    delete an existing ctag-pool
    +

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing ctag-pool

    +
    + +

    application/json application/xml +

    +
    @@ -34145,26 +35295,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -34395,29 +35366,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv6-address-list -
    -
    -
    - -
    default @@ -34440,17 +35388,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    @@ -34459,13 +35407,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

    - /l3-interface-ipv6-address-list + /relationship
    @@ -34484,26 +35432,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name that identifies the link aggregate interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -34177,10 +35311,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + target-pe -

    Name given to the interface

    +

    The Target provider edge router

    		 path @@ -34193,10 +35327,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + availability-zone-name -

    IP address

    +

    Name of the availability zone

    		 path @@ -34209,174 +35343,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -     		query - string - - -
    - neutron-subnet-id + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -34384,6 +35354,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name that identifies the link aggregate interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -34516,10 +35448,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + target-pe -

    Name given to the interface

    +

    The Target provider edge router

    		 path @@ -34532,10 +35464,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + availability-zone-name -

    IP address

    +

    Name of the availability zone

    		 path @@ -34577,17 +35509,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    delete an existing 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 l3-interface-ipv6-address-list

    +

    delete an existing relationship

    @@ -34609,26 +35541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name + physical-location-id -

    Name that identifies the link aggregate interface

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -34641,10 +35557,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + target-pe -

    Name given to the interface

    +

    The Target provider edge router

    		 path @@ -34657,10 +35573,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + availability-zone-name -

    IP address

    +

    Name of the availability zone

    		 path @@ -34671,22 +35587,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -34718,11 +35618,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -34737,7 +35637,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplex.json)

    @@ -34762,58 +35662,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + physical-location-id -

    IP address

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -34855,11 +35707,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -34887,58 +35739,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - hostname - -

    Value from executing hostname on the compute node.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + physical-location-id -

    IP address

    +

    Unique identifier for physical location, e.g., CLLI

    		 path @@ -34980,105 +35784,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    returns network-profiles
    +

    GET /cloud-infrastructure/network-profiles

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    returns network-profiles

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /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

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /network-profiles +
    +
    +
    + +
    default @@ -35101,24 +35848,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    returns network-profile
    +

    GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    returns network-profile

    -
    - -

    application/json application/xml -

    -
    @@ -35133,10 +35875,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - hostname + nm-profile-name -

    Value from executing hostname on the compute node.

    +

    Unique name of network profile.

    		 path @@ -35147,12 +35889,108 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)

    +

    +
    +
    +
    +
    + /network-profile +
    +
    +
    +
    +
    + + + + + + + + + + + + +
    - interface-name + nm-profile-name -

    Name that identifies the link aggregate interface

    +

    Unique name of network profile.

    		 path @@ -35163,12 +36001,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name + nm-profile-name -

    Name given to the interface

    +

    Unique name of network profile.

    		 path @@ -35210,19 +36121,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    delete an existing network-profile
    +

    DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

    Tags: CloudInfrastructure
    -

    returns sriov-vfs

    +

    delete an existing network-profile

    +
    + +

    application/json application/xml +

    +
    @@ -35237,10 +36153,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - hostname + nm-profile-name -

    Value from executing hostname on the compute node.

    +

    Unique name of network profile.

    		 path @@ -35253,12 +36169,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-version -

    Name that identifies the link aggregate interface

    +

    resource-version for concurrency

    		pathquery string @@ -35267,12 +36183,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/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/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + +
    - interface-name + nm-profile-name -

    Name given to the interface

    +

    Unique name of network profile.

    		 path @@ -35283,144 +36272,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 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name + nm-profile-name -

    Name of the network

    +

    Unique name of network profile.

    		querypath 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

    @@ -35443,7 +36416,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /pservers
    @@ -35471,17 +36444,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    returns pserver
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    returns sriov-vf

    +

    returns pserver

    @@ -35512,54 +36485,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -     		path - string - - - -
    inv-status @@ -35619,141 +36544,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -35780,7 +36570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /pserver
    @@ -35808,17 +36598,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing sriov-vf
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    create or update an existing pserver
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    create or update an existing sriov-vf

    +

    create or update an existing pserver

    @@ -35827,13 +36617,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

    +

    pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)

    - /sriov-vf + /pserver
    @@ -35866,54 +36656,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -     		path - string - - - -
    @@ -35945,23 +36687,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing pserver
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    delete an existing sriov-vf

    +

    update an existing pserver

    application/json application/xml

    +
    +
    +

    pserver object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /pserver +
    +
    +
    @@ -35991,70 +36745,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -36086,35 +36776,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 pserver
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing pserver

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -36146,44 +36824,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + - - - - - - - - + + + + + + + +
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id + resource-version -

    PCI ID used to identify the sriov-vf

    +

    resource-version for concurrency

    		pathquery string @@ -36223,24 +36869,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    returns lag-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    returns lag-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -36271,50 +36912,61 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -36326,6 +36978,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interfaces +
    +
    +
    + +
    default @@ -36348,17 +37023,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    returns lag-interface
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns vlans

    +

    returns lag-interface

    @@ -36405,22 +37080,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name + inv-status -

    Name that identifies the link aggregate interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - interface-name + pserver-id -

    Name given to the interface

    +

    ID of Pserver

    		pathquery string -
    - pci-id + in-maint -

    PCI ID used to identify the sriov-vf

    		pathquery + boolean + + +
    + pserver-name2 + +

    alternative pserver name

    +     		query string -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    inv-status @@ -36510,51 +37169,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -36581,7 +37195,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /lag-interface
    @@ -36609,19 +37223,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlan
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing lag-interface
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    returns vlan

    +

    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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    +
    @@ -36666,12 +37297,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 given to the interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -36682,12 +37402,193 @@ 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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing lag-interface

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vlan-interface + hostname -

    String that identifies the interface

    +

    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 @@ -36787,6 +37688,192 @@ 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 /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 @@ -36804,10 +37891,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + interface-role -

    MAC address for the interface

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -36819,10 +37906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-id -

    Name of the network

    +

    ID of interface

    		 query @@ -36834,14 +37921,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + macaddr -

    Inner VLAN tag

    +

    MAC address for the interface

    		 query - integer + string @@ -36849,10 +37936,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + network-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name of the network

    		 query @@ -36888,7 +37975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /l-interface
    @@ -36916,17 +38003,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing 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 vlan

    +

    create or update an existing l-interface

    @@ -36935,13 +38022,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    - /vlan + /l-interface
    @@ -37006,22 +38093,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    @@ -37053,23 +38124,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    delete an existing vlan

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -37131,12 +38214,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 + + + +
    - vlan-interface + interface-name -

    String that identifies the interface

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -37194,11 +38370,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
    @@ -37267,22 +38443,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -37448,36 +38608,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    neutron-network-id @@ -37534,7 +38664,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -37562,11 +38692,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
    @@ -37581,7 +38711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -37654,10 +38784,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    +     		path + 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 @@ -37715,11 +38966,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
    @@ -37793,22 +39044,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -37872,11 +39107,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    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
    @@ -37891,7 +39126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -37962,22 +39197,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -38025,11 +39244,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
    @@ -38103,22 +39322,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -38166,11 +39369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 /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
    @@ -38239,22 +39442,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv6-address @@ -38420,36 +39607,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    neutron-network-id @@ -38506,7 +39663,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -38534,11 +39691,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: CloudInfrastructure
    @@ -38553,7 +39710,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -38624,163 +39781,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    -
    - -
    -

    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 @@ -38797,22 +39797,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -38844,17 +39828,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -38863,13 +39847,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -38934,22 +39918,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv6-address @@ -38997,17 +39965,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-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 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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -39077,10 +40045,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -39093,12 +40061,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -39138,11 +40106,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/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
    @@ -39157,7 +40125,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -39230,10 +40198,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -39275,11 +40243,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/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
    @@ -39355,10 +40323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -39400,11 +40368,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -39419,7 +40387,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -39474,6 +40442,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    @@ -39505,11 +40489,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -39567,6 +40551,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    @@ -39598,17 +40598,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns p-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

    +
    returns sriov-vfs
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: CloudInfrastructure
    -

    returns p-interfaces

    +

    returns sriov-vfs

    @@ -39639,6 +40639,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    inv-status @@ -39698,6 +40730,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -39724,7 +40831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /p-interfaces + /sriov-vfs
    @@ -39752,17 +40859,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns p-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    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 p-interface

    +

    returns sriov-vf

    @@ -39798,7 +40905,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    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 @@ -39870,10 +41009,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    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 @@ -39909,7 +41168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /p-interface + /sriov-vf
    @@ -39937,17 +41196,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing p-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    +
    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 p-interface

    +

    create or update an existing sriov-vf

    @@ -39956,13 +41215,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /p-interface + /sriov-vf
    @@ -40000,84 +41259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    -     		path - string - - - -
    -
    - -
    -

    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.

    +

    Name that identifies the link aggregate interface

    		 path @@ -40093,7 +41275,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -40106,12 +41288,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -40151,19 +41333,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    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
    -

    returns l-interfaces

    +

    update an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    @@ -40197,7 +41396,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - + - + @@ -40291,29 +41448,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -40336,19 +41470,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    delete an existing sriov-vf
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: CloudInfrastructure
    -

    returns l-interface

    +

    delete an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -40210,76 +41409,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 + interface-name -

    alternative pserver name

    +

    Name given to the interface

    		querypath string +
    - prov-status + pci-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    @@ -40382,7 +41521,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -40537,29 +41589,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interface -
    -
    -
    - -
    default @@ -40582,17 +41611,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    create or update an existing l-interface

    +

    see node definition for valid relationships

    @@ -40601,13 +41630,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l-interface + /relationship
    @@ -40645,7 +41674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -40411,114 +41550,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + pci-id -

    MAC address for the interface

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - network-name + resource-version -

    Name of the network

    +

    resource-version for concurrency

    		 query @@ -40526,6 +41577,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -40672,6 +41701,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    @@ -40703,17 +41748,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    delete an existing 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 l-interface

    +

    delete an existing relationship

    @@ -40754,7 +41799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -40783,12 +41828,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -40828,17 +41873,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns vlans
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv4-address-list

    +

    returns vlans

    @@ -40874,7 +41919,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -40903,26 +41948,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + inv-status -

    IP address

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - inv-status + pserver-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    ID of Pserver

    		 query @@ -40934,14 +41978,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + in-maint -

    ID of Pserver

    		 query - string + boolean @@ -40949,13 +41992,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + pserver-name2 +

    alternative pserver name

    		 query - boolean + string @@ -40963,10 +42007,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-name2 + interface-id -

    alternative pserver name

    +

    ID of interface

    		 query @@ -40978,10 +42022,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-role -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -41036,51 +42080,6 @@ 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 - -

    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 - - -
    @@ -41107,7 +42106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /vlans
    @@ -41135,36 +42134,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /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 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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -41198,7 +42180,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -41227,10 +42209,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 @@ -41241,137 +42223,161 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing l3-interface-ipv4-address-list

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -41391,6 +42396,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    default @@ -41413,17 +42441,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    create or update an existing vlan
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    create or update an existing vlan

    @@ -41432,13 +42460,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

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /relationship + /vlan
    @@ -41476,7 +42504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - hostname + inv-status -

    Value from executing hostname on the compute node.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - interface-name + pserver-id -

    Name that identifies the physical interface

    +

    ID of Pserver

    		pathquery string -
    - interface-name + in-maint -

    Name given to the interface

    		pathquery + boolean + + +
    + pserver-name2 + +

    alternative pserver name

    +     		query string -
    - l3-interface-ipv4-address + interface-id -

    IP address

    +

    ID of interface

    		pathquery string -
    - resource-version + interface-role -

    resource-version for concurrency

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -41379,7 +42385,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -41505,10 +42533,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 @@ -41550,23 +42578,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing vlan
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    delete an existing relationship

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -41601,7 +42641,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -41630,10 +42670,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 @@ -41675,19 +42715,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    delete an existing vlan
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing vlan

    +
    + +

    application/json application/xml +

    +
    @@ -41721,7 +42766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -41750,7 +42795,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + 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

    @@ -41825,10 +43022,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -41898,6 +43110,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    neutron-network-id @@ -41954,7 +43196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -41982,17 +43224,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: CloudInfrastructure
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -42001,13 +43243,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -42045,7 +43287,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -42074,7 +43316,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -42119,23 +43377,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/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-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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -42170,7 +43440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -42199,10 +43469,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 @@ -42215,12 +43485,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -42260,35 +43530,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -42323,7 +43581,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -42352,7 +43610,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -42366,6 +43640,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -42397,23 +43687,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -42448,7 +43750,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -42477,7 +43779,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -42522,35 +43840,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -42585,7 +43891,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -42612,89 +43918,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/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 + vlan-interface -

    Name that identifies the physical interface

    +

    String that identifies the interface

    		 path @@ -42707,10 +43936,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -42752,17 +43981,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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 sriov-vfs

    +

    returns l3-interface-ipv6-address-list

    @@ -42798,7 +44027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -42827,43 +44056,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vlan-interface -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String that identifies the interface

    		querypath string +
    - pserver-id + l3-interface-ipv6-address -

    ID of Pserver

    +

    IP address

    		querypath string +
    - in-maint + inv-status +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query - boolean + string @@ -42871,10 +44103,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-name2 + pserver-id -

    alternative pserver name

    +

    ID of Pserver

    		 query @@ -42886,10 +44118,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + in-maint -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		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 @@ -42944,6 +44220,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    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 + + +
    @@ -42970,7 +44321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /l3-interface-ipv6-address-list
    @@ -42998,19 +44349,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    returns sriov-vf

    +

    create or update an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    @@ -43044,7 +44412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -43275,29 +44480,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vf -
    -
    -
    - -
    default @@ -43320,17 +44502,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing sriov-vf
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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
    -

    create or update an existing sriov-vf

    +

    update an existing l3-interface-ipv6-address-list

    @@ -43339,13 +44521,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -43383,7 +44565,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -43073,10 +44441,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -43089,181 +44457,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - pserver-id - -

    ID of Pserver

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - pserver-name2 - -

    alternative pserver name

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - 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 + l3-interface-ipv6-address -

    Neutron network id of the interface

    +

    IP address

    		querypath string +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -43412,10 +44594,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -43457,17 +44655,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    delete an existing 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 sriov-vf

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -43508,7 +44706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -43537,10 +44735,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -43598,11 +44812,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/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
    @@ -43617,7 +44831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -43661,7 +44875,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -43690,10 +44904,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -43735,11 +44965,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/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
    @@ -43786,7 +45016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -43815,10 +45045,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -43860,19 +45106,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -43906,7 +45169,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -43935,121 +45198,248 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vlan-interface -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String that identifies the interface

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    + Tags: + CloudInfrastructure +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + - - - - - - - - + - + - + + +
    - pserver-id + hostname -

    ID of Pserver

    +

    Value from executing hostname on the compute node.

    		querypath string +
    - in-maint - - query - boolean - - -
    - pserver-name2 + interface-name -

    alternative pserver name

    +

    Name that identifies the link aggregate 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 +
    - interface-id + vlan-interface -

    ID of interface

    +

    String that identifies the interface

    		querypath 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/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + @@ -44061,29 +45451,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -44106,19 +45473,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    -

    returns vlan

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - macaddr + hostname -

    MAC address for the interface

    +

    Value from executing hostname on the compute node.

    		querypath string +
    - network-name + interface-name -

    Name of the network

    +

    Name that identifies the link aggregate interface

    		querypath string +
    @@ -44152,7 +45524,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -44163,12 +45535,68 @@ 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 p-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns p-interfaces

    + +
    +
    + + + + + + + + + + + - + + +
    - interface-name + hostname -

    Name given to the interface

    +

    Value from executing hostname on the compute node.

    		 path @@ -44181,26 +45609,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + inv-status -

    String that identifies the interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - inv-status + pserver-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    ID of Pserver

    		 query @@ -44212,14 +45639,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + in-maint -

    ID of Pserver

    		 query - string + boolean @@ -44227,54 +45653,136 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + pserver-name2 +

    alternative pserver name

    		 query - boolean + 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

    + +
    +
    + + + + + + + + + + + - + - + - - - - - - - - - - - - - -
    - pserver-name2 + hostname -

    alternative pserver name

    +

    Value from executing hostname on the compute node.

    		querypath string +
    - prov-status + interface-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Name that identifies the physical interface

    		querypath string +
    - interface-id + inv-status -

    ID of interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -44286,10 +45794,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + pserver-id -

    MAC address for the interface

    +

    ID of Pserver

    		 query @@ -44301,14 +45809,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + in-maint -

    Name of the network

    		 query - string + boolean @@ -44316,14 +45823,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + pserver-name2 -

    Inner VLAN tag

    +

    alternative pserver name

    		 query - integer + string @@ -44331,10 +45838,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + prov-status -

    This indicates the customers VPN ID associated with this vlan

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -44370,7 +45877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /p-interface
    @@ -44398,17 +45905,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing p-interface
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    create or update an existing vlan

    +

    create or update an existing p-interface

    @@ -44417,13 +45924,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    - /vlan + /p-interface
    @@ -44472,38 +45979,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    @@ -44535,23 +46010,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing p-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    delete an existing vlan

    +

    update an existing p-interface

    application/json application/xml

    +
    +
    +

    p-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    @@ -44597,12 +46084,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - + - + - + + +
    - interface-name + hostname -

    Name given to the interface

    +

    Value from executing hostname on the compute node.

    		 path @@ -44615,10 +46163,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 that identifies the physical interface

    		 path @@ -44676,17 +46224,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns l-interfaces
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: CloudInfrastructure
    -

    returns l3-interface-ipv4-address-list

    +

    returns l-interfaces

    @@ -44735,58 +46283,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + inv-status -

    Name given to the interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - vlan-interface + pserver-id -

    String that identifies the interface

    +

    ID of Pserver

    		pathquery string -
    - l3-interface-ipv4-address + in-maint -

    IP address

    		pathquery - string + boolean -
    - inv-status + pserver-name2 -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    alternative pserver name

    		 query @@ -44798,10 +46342,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver-id + prov-status -

    ID of Pserver

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -44811,56 +46355,139 @@ 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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns l-interface

    + +
    +
    + + + + + + + + + + + - + - + - + - - - - - - - - - - - - - -
    - in-maint + hostname +

    Value from executing hostname on the compute node.

    		querypath - boolean + string +
    - pserver-name2 + interface-name -

    alternative pserver name

    +

    Name that identifies the physical interface

    		querypath string +
    - prov-status + interface-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Name given to the interface

    		querypath string +
    - interface-id + inv-status -

    ID of interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -44872,10 +46499,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + pserver-id -

    MAC address for the interface

    +

    ID of Pserver

    		 query @@ -44887,14 +46514,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + in-maint -

    Name of the network

    		 query - string + boolean @@ -44902,14 +46528,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + pserver-name2 -

    Inner VLAN tag

    +

    alternative pserver name

    		 query - integer + string @@ -44917,10 +46543,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + prov-status -

    This indicates the customers VPN ID associated with this vlan

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -44932,14 +46558,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-id -

    Inner VLAN tag

    +

    ID of interface

    		 query - integer + string @@ -44947,10 +46573,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + macaddr -

    Neutron network id of the interface that address belongs to

    +

    MAC address for the interface

    		 query @@ -44962,10 +46588,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + network-name -

    Neutron id of subnet that address belongs to

    +

    Name of the network

    		 query @@ -45001,7 +46627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l-interface
    @@ -45029,17 +46655,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing l-interface
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    create or update an existing l-interface

    @@ -45048,13 +46674,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

    - /l3-interface-ipv4-address-list + /l-interface
    @@ -45119,38 +46745,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -45182,23 +46776,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /cloud-infrastructure/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 l-interface
    +

    PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    delete an existing l3-interface-ipv4-address-list

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -45260,54 +46866,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -45339,35 +46897,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 l-interface
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing l-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -45431,28 +46977,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - +
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -45492,24 +47022,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    returns 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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -45572,10 +47097,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -45588,179 +47113,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + inv-status -

    IP address

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery 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 + pserver-id -

    Value from executing hostname on the compute node.

    +

    ID of Pserver

    		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

    -     		queryquery string @@ -45872,36 +47245,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    neutron-network-id @@ -45958,7 +47301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -45986,17 +47329,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /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-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -46005,13 +47348,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -46078,23 +47421,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -46139,23 +47466,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /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-ipv6-address-list

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -46219,23 +47558,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -46249,22 +47572,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -46296,35 +47603,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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 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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -46388,10 +47683,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -46404,12 +47699,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -46449,23 +47744,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -46529,23 +47836,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -46590,35 +47881,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/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
    +

    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -46682,10 +47961,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -46727,24 +48006,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -46807,10 +48081,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -46821,6 +48095,170 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + pserver-id + +

    ID of Pserver

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + pserver-name2 + +

    alternative pserver name

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    +     		query + string + + +
    + neutron-subnet-id + +

    Neutron id of subnet that address belongs to

    +     		query + string + + +
    @@ -46830,6 +48268,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -46852,17 +48313,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -46871,13 +48332,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /relationship + /l3-interface-ipv6-address-list
    @@ -46926,73 +48387,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    - Tags: - CloudInfrastructure -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
    - hostname + interface-name -

    Value from executing hostname on the compute node.

    +

    Name given to the interface

    		 path @@ -47005,10 +48405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name that identifies the physical interface

    +

    IP address

    		 path @@ -47050,17 +48450,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -47069,13 +48469,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -47108,6 +48508,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -47139,17 +48587,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -47185,132 +48633,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + + @@ -47345,29 +48706,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /virtual-data-center -
    -
    -
    - -
    default @@ -47390,17 +48728,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing virtual-data-center
    -

    PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    +
    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
    -

    create or update an existing virtual-data-center

    +

    see node definition for valid relationships

    @@ -47409,13 +48747,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    virtual-data-center object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /virtual-data-center + /relationship
    @@ -47434,10 +48772,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - +
    - vdc-id + interface-name -

    Unique ID of the vdc

    +

    Name that identifies the physical interface

    		 path @@ -47323,10 +48651,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vdc-name + interface-name -

    Name of the virtual data center

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -47334,6 +48694,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - vdc-id + hostname -

    Unique ID of the vdc

    +

    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 @@ -47479,17 +48865,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing virtual-data-center
    -

    DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    +
    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 virtual-data-center

    +

    delete an existing relationship

    @@ -47511,10 +48897,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vdc-id + hostname -

    Unique ID of the vdc

    +

    Value from executing hostname on the compute node.

    		 path @@ -47527,12 +48913,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -47572,11 +48990,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -47591,7 +49009,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

    @@ -47616,10 +49034,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vdc-id + hostname -

    Unique ID of the vdc

    +

    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 @@ -47661,11 +49111,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: CloudInfrastructure
    @@ -47693,10 +49143,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vdc-id + hostname -

    Unique ID of the vdc

    +

    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 @@ -47738,81 +49220,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    returns sriov-vfs
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: - Network + CloudInfrastructure
    -

    returns generic-vnf

    +

    returns sriov-vfs

    @@ -47829,10 +49247,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -47845,85 +49263,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id + interface-name -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Name that identifies the physical interface

    		querypath string +
    - regional-resource-zone + interface-name -

    Regional way of organizing pservers, source of truth should define values

    +

    Name given to the interface

    		querypath string +
    - prov-status + inv-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -47935,10 +49310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + pserver-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    ID of Pserver

    		 query @@ -47964,13 +49339,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + pserver-name2 +

    alternative pserver name

    		 query - boolean + string @@ -47978,10 +49354,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + prov-status -

    the ASDC model id for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -47993,10 +49369,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + interface-id -

    the ASDC model version for this resource or service model.

    +

    ID of interface

    		 query @@ -48008,10 +49384,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + macaddr -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    MAC address for the interface

    		 query @@ -48023,10 +49399,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + network-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name of the network

    		 query @@ -48062,7 +49438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /generic-vnf + /sriov-vfs
    @@ -48090,36 +49466,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing generic-vnf
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}

    +
    returns 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: - Network + CloudInfrastructure
    -

    create or update an existing generic-vnf

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    generic-vnf object that needs to be created or updated

    -

    -
    -
    -
    -
    - /generic-vnf -
    -
    -
    -
    @@ -48134,10 +49493,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -48148,73 +49507,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing generic-vnf
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    - Tags: - Network -
    -
    -
    -

    delete an existing generic-vnf

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - vnf-id + interface-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name that identifies the physical interface

    		 path @@ -48227,12 +49525,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -48241,68 +49539,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns entitlements
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

    - Tags: - Network -
    -
    -
    -

    returns entitlements

    - -
    -
    - - - - - - - - - - - - - - - - - -
    - vnf-id + pci-id -

    Unique id of VNF. This is unique across the graph.

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -48315,25 +49557,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 + inv-status -

    Alternate name of VNF.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -48345,10 +49572,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + pserver-id -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    ID of Pserver

    		 query @@ -48360,14 +49587,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + in-maint -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query - string + boolean @@ -48375,10 +49601,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + pserver-name2 -

    Regional way of organizing pservers, source of truth should define values

    +

    alternative pserver name

    		 query @@ -48405,10 +49631,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    ID of interface

    		 query @@ -48420,13 +49646,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + macaddr +

    MAC address for the interface

    		 query - boolean + string @@ -48434,13 +49661,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + network-name +

    Name of the network

    		 query - boolean + string @@ -48448,10 +49676,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + vf-vlan-filter -

    the ASDC model id for this resource or service model.

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query @@ -48463,10 +49691,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + vf-mac-filter -

    the ASDC model version for this resource or service model.

    +

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    		 query @@ -48478,14 +49706,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vf-vlan-strip -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    		 query - string + boolean @@ -48493,10 +49721,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + neutron-network-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Neutron network id of the interface

    		 query @@ -48532,7 +49760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /entitlements + /sriov-vf
    @@ -48560,19 +49788,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlement
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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: - Network + CloudInfrastructure
    -

    returns entitlement

    +

    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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    @@ -48587,10 +49832,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -48835,29 +49903,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /entitlement -
    -
    -
    - -
    default @@ -48880,17 +49925,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing entitlement
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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: - Network + CloudInfrastructure
    -

    create or update an existing entitlement

    +

    update an existing sriov-vf

    @@ -48899,13 +49944,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    entitlement object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated.

    - /entitlement + /sriov-vf
    @@ -48924,10 +49969,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - + + + + + + + + + + + + + +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -48603,10 +49848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -48619,10 +49864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    		 path @@ -48635,195 +49880,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - 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 - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 + pci-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -48940,10 +49985,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -48956,10 +50001,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -49001,17 +50062,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing entitlement
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    delete an existing 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: - Network + CloudInfrastructure
    -

    delete an existing entitlement

    +

    delete an existing sriov-vf

    @@ -49033,10 +50094,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -49049,10 +50110,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -49065,10 +50126,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -49126,13 +50203,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +

    PUT /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: - Network + CloudInfrastructure
    @@ -49145,7 +50222,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -49170,10 +50247,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -49186,10 +50263,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -49202,10 +50279,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -49247,13 +50340,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +

    DELETE /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: - Network + CloudInfrastructure
    @@ -49279,10 +50372,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -49295,10 +50388,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -49311,10 +50404,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -49356,17 +50465,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

    +
    returns vlans
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: - Network + CloudInfrastructure
    -

    returns l-interfaces

    +

    returns vlans

    @@ -49383,10 +50492,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -49399,85 +50508,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id + interface-name -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Name that identifies the physical interface

    		querypath string +
    - regional-resource-zone + interface-name -

    Regional way of organizing pservers, source of truth should define values

    +

    Name given to the interface

    		querypath string +
    - prov-status + inv-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -49489,10 +50555,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + pserver-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    ID of Pserver

    		 query @@ -49518,13 +50584,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + pserver-name2 +

    alternative pserver name

    		 query - boolean + string @@ -49532,10 +50599,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + prov-status -

    the ASDC model id for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -49547,10 +50614,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + interface-id -

    the ASDC model version for this resource or service model.

    +

    ID of interface

    		 query @@ -49562,10 +50629,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + macaddr -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    MAC address for the interface

    		 query @@ -49577,10 +50644,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + network-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name of the network

    		 query @@ -49616,7 +50683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /vlans
    @@ -49644,17 +50711,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    +
    returns vlan
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: - Network + CloudInfrastructure
    -

    returns l-interface

    +

    returns vlan

    @@ -49671,10 +50738,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -49690,7 +50757,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 physical interface

    		 path @@ -49703,85 +50770,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id + interface-name -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Name given to the interface

    		querypath string +
    - regional-resource-zone + vlan-interface -

    Regional way of organizing pservers, source of truth should define values

    +

    String that identifies the interface

    		querypath string +
    - prov-status + inv-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -49793,10 +50817,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + pserver-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    ID of Pserver

    		 query @@ -49822,24 +50846,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled - - query - boolean - - -
    - persona-model-id + pserver-name2 -

    the ASDC model id for this resource or service model.

    +

    alternative pserver name

    		 query @@ -49851,10 +50861,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + prov-status -

    the ASDC model version for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -49866,10 +50876,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + interface-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    ID of interface

    		 query @@ -49881,10 +50891,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + macaddr -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    MAC address for the interface

    		 query @@ -49896,10 +50906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + network-name -

    ID of interface

    +

    Name of the network

    		 query @@ -49911,14 +50921,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    +

    Inner VLAN tag

    		 query - string + integer @@ -49926,10 +50936,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-id -

    Name of the network

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -49965,7 +50975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /vlan
    @@ -49993,17 +51003,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    +
    create or update an existing vlan
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: - Network + CloudInfrastructure
    -

    create or update an existing l-interface

    +

    create or update an existing vlan

    @@ -50012,13 +51022,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /l-interface + /vlan
    @@ -50037,10 +51047,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -50067,6 +51093,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    @@ -50098,23 +51140,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    +
    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: - Network + CloudInfrastructure
    -

    delete an existing l-interface

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -50130,10 +51184,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + - - - - - - - - + + + + + + + +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -50162,12 +51232,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath string @@ -50207,19 +51277,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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: - Network + CloudInfrastructure
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing vlan

    +
    + +

    application/json application/xml +

    +
    @@ -50234,10 +51309,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -50266,10 +51357,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 @@ -50282,10 +51373,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + resource-version -

    Name of VNF.

    +

    resource-version for concurrency

    		 query @@ -50293,89 +51384,151 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l3-interface-ipv4-address-list
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-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

    + +
    +
    + + + + + + + + + + + - + - + - + - + - + @@ -50415,10 +51569,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - -
    - vnf-name2 + hostname -

    Alternate name of VNF.

    +

    Value from executing hostname on the compute node.

    		querypath string +
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name that identifies the physical interface

    		querypath string +
    - service-id + interface-name -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Name given to the interface

    		querypath string +
    - regional-resource-zone + vlan-interface -

    Regional way of organizing pservers, source of truth should define values

    +

    String that identifies the interface

    		querypath string +
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    IP address

    		querypath string +
    - heat-stack-id + inv-status -

    Heat stack id corresponding to this instance, managed by MSO

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -50387,13 +51540,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + pserver-id +

    ID of Pserver

    		 query - boolean + string @@ -50401,7 +51555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + in-maint
    - persona-model-id + pserver-name2 -

    the ASDC model id for this resource or service model.

    +

    alternative pserver name

    		 query @@ -50430,10 +51584,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + prov-status -

    the ASDC model version for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -50445,10 +51599,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + interface-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    ID of interface

    		 query @@ -50460,10 +51614,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + macaddr -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    MAC address for the interface

    		 query @@ -50475,10 +51629,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + network-name -

    ID of interface

    +

    Name of the network

    		 query @@ -50490,14 +51644,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    +

    Inner VLAN tag

    		 query - string + integer @@ -50505,10 +51659,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-id -

    Name of the network

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -50589,7 +51743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -50617,13 +51771,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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: - Network + CloudInfrastructure
    @@ -50636,7 +51790,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -50661,10 +51815,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -50691,6 +51861,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    l3-interface-ipv4-address @@ -50738,23 +51924,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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
    +

    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: - Network + CloudInfrastructure
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -50770,10 +51968,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + - - - - - - - - - - - - - -
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -50802,10 +52016,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 @@ -50818,12 +52032,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -50863,35 +52077,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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: - Network + CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -50907,10 +52109,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -50937,6 +52155,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    l3-interface-ipv4-address @@ -50953,6 +52187,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -50984,23 +52234,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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: - Network + CloudInfrastructure
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -51016,10 +52278,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -51046,6 +52324,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    l3-interface-ipv4-address @@ -51093,19 +52387,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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: - Network + CloudInfrastructure
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -51120,10 +52419,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + + +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -51152,10 +52467,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 @@ -51168,100 +52483,162 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + l3-interface-ipv4-address -

    Name of VNF.

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l3-interface-ipv6-address-list
    +

    GET /cloud-infrastructure/pservers/pserver/{hostname}/p-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

    + +
    +
    + + + + + + + + + + + - + - + - + - + - + @@ -51301,10 +52679,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + - - - - - - - - - - - - - - + +
    - vnf-name2 + hostname -

    Alternate name of VNF.

    +

    Value from executing hostname on the compute node.

    		querypath string +
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name that identifies the physical interface

    		querypath string +
    - service-id + interface-name -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Name given to the interface

    		querypath string +
    - regional-resource-zone + vlan-interface -

    Regional way of organizing pservers, source of truth should define values

    +

    String that identifies the interface

    		querypath string +
    - prov-status + l3-interface-ipv6-address -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    IP address

    		querypath string +
    - heat-stack-id + inv-status -

    Heat stack id corresponding to this instance, managed by MSO

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -51273,13 +52650,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + pserver-id +

    ID of Pserver

    		 query - boolean + string @@ -51287,7 +52665,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + in-maint
    - persona-model-id + pserver-name2 -

    the ASDC model id for this resource or service model.

    +

    alternative pserver name

    		 query @@ -51316,10 +52694,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + prov-status -

    the ASDC model version for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -51331,10 +52709,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + interface-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    ID of interface

    		 query @@ -51346,10 +52724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + macaddr -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    MAC address for the interface

    		 query @@ -51361,10 +52739,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + network-name -

    ID of interface

    +

    Name of the network

    		 query @@ -51376,14 +52754,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    +

    Inner VLAN tag

    		 query - string + integer @@ -51391,10 +52769,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vpn-id -

    Name of the network

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -51475,7 +52853,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -51503,13 +52881,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: - Network + CloudInfrastructure
    @@ -51522,7 +52900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -51547,10 +52925,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -51577,6 +52971,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    l3-interface-ipv6-address @@ -51624,23 +53034,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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
    +

    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: - Network + CloudInfrastructure
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -51656,10 +53078,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -51688,10 +53126,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 @@ -51704,12 +53142,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv6-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -51749,35 +53187,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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: - Network + CloudInfrastructure
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -51793,10 +53219,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -51812,7 +53238,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 physical interface

    		 path @@ -51825,10 +53251,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 @@ -51839,73 +53265,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 + vlan-interface -

    Unique id of VNF. This is unique across the graph.

    +

    String that identifies the interface

    		 path @@ -51918,10 +53283,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name given to the interface

    +

    IP address

    		 path @@ -51934,12 +53299,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -51979,13 +53344,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    @@ -51998,7 +53363,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -52023,10 +53388,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -52053,6 +53434,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -52084,13 +53497,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    @@ -52116,10 +53529,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -52146,6 +53575,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -52177,19 +53638,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    -

    returns sriov-vfs

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -52204,10 +53682,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -52481,29 +53753,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -52526,19 +53775,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vf
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    -

    returns sriov-vf

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -52223,7 +53701,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 physical interface

    		 path @@ -52236,240 +53714,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name given to the interface

    		querypath string +
    - network-name + vlan-interface -

    Name of the network

    +

    String that identifies the interface

    		querypath string +
    @@ -52553,10 +53807,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -52906,29 +53878,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vf -
    -
    -
    - -
    default @@ -52951,17 +53900,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/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    -

    create or update an existing sriov-vf

    +

    see node definition for valid relationships

    @@ -52970,13 +53919,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

    - /sriov-vf + /relationship
    @@ -52995,10 +53944,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - -
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -52572,7 +53826,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 physical interface

    		 path @@ -52585,10 +53839,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 @@ -52601,300 +53855,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - 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 - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 - - -
    - 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 + vlan-interface -

    Neutron network id of the interface

    +

    String that identifies the interface

    		querypath string +
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -53014,23 +53963,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    +

    Name that identifies the physical interface

    		 path @@ -53072,17 +54005,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    delete an existing relationship
    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    -

    delete an existing sriov-vf

    +

    delete an existing relationship

    @@ -53104,10 +54037,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -53123,23 +54056,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - pci-id - -

    PCI ID used to identify the sriov-vf

    +

    Name that identifies the physical interface

    		 path @@ -53150,22 +54067,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -53197,13 +54098,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    @@ -53216,7 +54117,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)

    @@ -53241,42 +54142,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id + hostname -

    PCI ID used to identify the sriov-vf

    +

    Value from executing hostname on the compute node.

    		 path @@ -53318,13 +54187,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

    Tags: - Network + CloudInfrastructure
    @@ -53350,10 +54219,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + hostname -

    Unique id of VNF. This is unique across the graph.

    +

    Value from executing hostname on the compute node.

    		 path @@ -53364,12 +54233,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns virtual-data-centers
    +

    GET /cloud-infrastructure/virtual-data-centers

    + Tags: + CloudInfrastructure +
    +
    +
    +

    returns virtual-data-centers

    + +
    + +
    +

    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

    + +
    +
    + + + + + + + + + + + - + @@ -53405,6 +54393,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /virtual-data-center +
    +
    +
    + +
    default @@ -53427,19 +54438,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

    +
    create or update an existing virtual-data-center
    +

    PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

    Tags: - Network + CloudInfrastructure
    -

    returns vlans

    +

    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/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

    +

    +
    +
    +
    +
    + /virtual-data-center +
    +
    +
    +
    - interface-name + vdc-id -

    Name given to the interface

    +

    Unique ID of the vdc

    		 path @@ -53382,18 +54371,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vdc-name -

    PCI ID used to identify the sriov-vf

    +

    Name of the virtual data center

    		pathquery string -
    @@ -53454,26 +54482,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - interface-name + vdc-id -

    Name given to the interface

    +

    Unique ID of the vdc

    		 path @@ -53484,205 +54496,178 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
    - 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 - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    the ASDC model version for this resource or service model.

    -     		query - string - - -
    - widget-model-id + vdc-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Unique ID of the vdc

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - + + +
    - widget-model-version + vdc-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Unique ID of the vdc

    		querypath string +
    - interface-id + resource-version -

    ID of interface

    +

    resource-version for concurrency

    		 query @@ -53690,42 +54675,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /cloud-infrastructure/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/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - macaddr + vdc-id -

    MAC address for the interface

    +

    Unique ID of the vdc

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - +
    - network-name + vdc-id -

    Name of the network

    +

    Unique ID of the vdc

    		querypath 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

    @@ -53748,7 +54911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /generic-vnfs
    @@ -53776,17 +54939,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlan
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns generic-vnf
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    returns vlan

    +

    returns generic-vnf

    @@ -53817,38 +54980,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    vnf-name @@ -54042,81 +55173,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -54143,7 +55199,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /generic-vnf
    @@ -54171,17 +55227,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing generic-vnf
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    create or update an existing vlan

    +

    create or update an existing generic-vnf

    @@ -54190,13 +55246,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)

    - /vlan + /generic-vnf
    @@ -54229,38 +55285,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    @@ -54292,23 +55316,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing generic-vnf
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

    Tags: Network
    -

    delete an existing vlan

    +

    update an existing generic-vnf

    application/json application/xml

    +
    +
    +

    generic-vnf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /generic-vnf +
    +
    +
    @@ -54338,28 +55374,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing generic-vnf
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

    + Tags: + Network +
    +
    +
    +

    delete an existing generic-vnf

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + vnf-id -

    String that identifies the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -54417,17 +55498,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns entitlements
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    returns entitlements

    @@ -54458,54 +55539,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    vnf-name @@ -54699,126 +55732,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -54845,7 +55758,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /entitlements
    @@ -54873,36 +55786,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns entitlement
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns entitlement

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -54933,10 +55829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - -
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -54949,10 +55845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of an entitlement resource.

    		 path @@ -54965,551 +55861,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + vnf-name -

    IP address

    +

    Name of VNF.

    		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

    -

    -
    -
    -
    -
    - /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.

    -     		queryquery string @@ -55695,126 +56052,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 - - -
    @@ -55841,7 +56078,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /entitlement
    @@ -55869,17 +56106,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    create or update an existing entitlement

    @@ -55888,13 +56125,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

    +

    entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

    - /l3-interface-ipv6-address-list + /entitlement
    @@ -55929,151 +56166,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    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 + group-uuid -

    String that identifies the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56086,10 +56182,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-uuid -

    IP address

    +

    Unique ID of an entitlement resource.

    		 path @@ -56100,22 +56196,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -56147,17 +56227,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing entitlement
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing entitlement

    @@ -56166,13 +56246,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

    +

    entitlement object that needs to be created or updated.

    - /relationship + /entitlement
    @@ -56207,26 +56287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + group-uuid -

    String that identifies the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56239,10 +56303,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-uuid -

    IP address

    +

    Unique ID of an entitlement resource.

    		 path @@ -56284,17 +56348,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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 entitlement
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing entitlement

    @@ -56332,10 +56396,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56348,10 +56412,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of an entitlement resource.

    		 path @@ -56364,12 +56428,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -56409,11 +56473,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -56428,7 +56492,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

    @@ -56469,10 +56533,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56485,10 +56549,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of an entitlement resource.

    		 path @@ -56530,11 +56594,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -56578,10 +56642,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -56594,10 +56658,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of an entitlement resource.

    		 path @@ -56639,17 +56703,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

    +
    returns l-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

    Tags: Network
    -

    returns lag-interfaces

    +

    returns l-interfaces

    @@ -56899,7 +56963,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /l-interfaces
    @@ -56927,17 +56991,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns lag-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    +
    returns l-interface
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    returns lag-interface

    +

    returns l-interface

    @@ -56973,7 +57037,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 given to the interface

    		 path @@ -57194,10 +57258,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + macaddr -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    		 query @@ -57233,7 +57312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /l-interface
    @@ -57261,17 +57340,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/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    +
    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 lag-interface

    +

    create or update an existing l-interface

    @@ -57280,13 +57359,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

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

    - /lag-interface + /l-interface
    @@ -57324,7 +57403,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 given to the interface

    		 path @@ -57366,23 +57445,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing lag-interface
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    +
    update an existing l-interface
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    delete an existing lag-interface

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -57417,7 +57508,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 given to the interface

    		 path @@ -57428,22 +57519,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -57475,19 +57550,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +
    delete an existing l-interface
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    returns l-interfaces

    +

    delete an existing l-interface

    +
    + +

    application/json application/xml +

    +
    @@ -57521,7 +57601,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -57764,29 +57637,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -57809,17 +57659,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    returns l3-interface-ipv4-address-list

    @@ -57855,7 +57705,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 given to the interface

    		 path @@ -57534,218 +57614,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id + resource-version -

    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 - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    resource-version for concurrency

    		 query @@ -57753,6 +57625,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    -

    Name that identifies the link aggregate interface

    +

    Name given to the interface

    		 path @@ -57868,10 +57718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -58092,10 +57942,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + macaddr -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    MAC address for the interface

    		 query @@ -58107,10 +57957,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + network-name -

    ID of interface

    +

    Name of the network

    		 query @@ -58122,10 +57972,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -58137,10 +58002,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + neutron-subnet-id -

    Name of the network

    +

    Neutron id of subnet that address belongs to

    		 query @@ -58176,7 +58041,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /l3-interface-ipv4-address-list
    @@ -58204,17 +58069,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -58223,13 +58088,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /l-interface + /l3-interface-ipv4-address-list
    @@ -58267,7 +58132,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 given to the interface

    		 path @@ -58280,10 +58145,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -58325,23 +58190,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    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 +
    +
    +
    @@ -58376,7 +58253,100 @@ 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 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 @@ -58403,6 +58373,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    resource-version @@ -58450,19 +58436,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /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
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -58496,7 +58499,100 @@ 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 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 @@ -58539,6 +58635,110 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l3-interface-ipv6-address-list
    +

    GET /network/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 @@ -58747,36 +58947,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    macaddr @@ -58878,7 +59048,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -58906,17 +59076,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/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-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-ipv4-address-list

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -58925,13 +59095,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -58964,22 +59134,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -58998,7 +59152,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -59043,23 +59197,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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-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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -59089,22 +59255,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -59123,7 +59273,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -59137,22 +59287,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -59184,35 +59318,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -59247,7 +59369,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 given to the interface

    		 path @@ -59260,10 +59382,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name given to the interface

    +

    IP address

    		 path @@ -59276,12 +59398,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -59321,23 +59443,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -59367,22 +59501,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -59401,7 +59519,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -59446,19 +59564,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -59492,7 +59615,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 given to the interface

    		 path @@ -59505,10 +59628,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name given to the interface

    +

    IP address

    		 path @@ -59519,12 +59642,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + + +
    - l3-interface-ipv6-address + vnf-id -

    IP address

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -59537,85 +59733,207 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + interface-name -

    Name of VNF.

    +

    Name given to the interface

    		querypath string +
    +
    + +
    +

    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-name2 + vnf-id -

    Alternate name of VNF.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name given to the interface

    		querypath 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

    + +
    +
    + + + + + + + + + + + - + - + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - service-id + vnf-id -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - regional-resource-zone + interface-name -

    Regional way of organizing pservers, source of truth should define values

    +

    Name given to the interface

    		querypath string +
    - prov-status + vnf-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Name of VNF.

    		 query @@ -59627,10 +59945,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vnf-name2 -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Alternate name of VNF.

    		 query @@ -59642,13 +59960,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + 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 - boolean + string @@ -59656,13 +59975,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + service-id +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query - boolean + string @@ -59670,10 +59990,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + regional-resource-zone -

    the ASDC model id for this resource or service model.

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -59685,10 +60005,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + prov-status -

    the ASDC model version for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -59700,10 +60020,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + heat-stack-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -59715,14 +60035,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + in-maint -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query - string + boolean @@ -59730,14 +60049,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + is-closed-loop-disabled -

    ID of interface

    		 query - string + boolean @@ -59745,10 +60063,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + persona-model-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    the ASDC model id for this resource or service model.

    		 query @@ -59760,10 +60078,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + persona-model-version -

    ID of interface

    +

    the ASDC model version for this resource or service model.

    		 query @@ -59775,10 +60093,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + widget-model-id -

    MAC address for the interface

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -59790,10 +60108,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + widget-model-version -

    Name of the network

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -59805,14 +60123,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-id -

    Inner VLAN tag

    +

    ID of interface

    		 query - integer + string @@ -59820,10 +60138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + macaddr -

    Neutron network id of the interface that address belongs to

    +

    MAC address for the interface

    		 query @@ -59835,10 +60153,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + network-name -

    Neutron id of subnet that address belongs to

    +

    Name of the network

    		 query @@ -59874,7 +60192,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /sriov-vfs
    @@ -59902,36 +60220,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -59965,7 +60266,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -60017,6 +60600,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -60039,23 +60645,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 sriov-vf
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    -

    Name that identifies the link aggregate interface

    +

    Name given to the interface

    		 path @@ -59978,10 +60279,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + pci-id -

    Name given to the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -59994,18 +60295,300 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vnf-name -

    IP address

    +

    Name of VNF.

    		pathquery + 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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 + + +
    + 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 -
    @@ -60085,22 +60703,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -60119,10 +60721,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60133,22 +60735,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -60180,17 +60766,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing sriov-vf
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing sriov-vf

    @@ -60199,13 +60785,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

    +

    sriov-vf object that needs to be created or updated.

    - /relationship + /sriov-vf
    @@ -60238,22 +60824,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -60272,10 +60842,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + pci-id -

    IP address

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60317,17 +60887,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing sriov-vf

    @@ -60368,7 +60938,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 given to the interface

    		 path @@ -60381,10 +60951,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + pci-id -

    Name given to the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60397,12 +60967,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -60442,11 +61012,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    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
    @@ -60461,7 +61031,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -60505,7 +61075,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 given to the interface

    		 path @@ -60518,10 +61088,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + pci-id -

    Name given to the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60563,11 +61133,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/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
    @@ -60614,7 +61184,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 given to the interface

    		 path @@ -60627,10 +61197,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + pci-id -

    Name given to the interface

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -60672,17 +61242,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    returns vlans
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns sriov-vfs

    +

    returns vlans

    @@ -60713,22 +61283,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -60953,36 +61507,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    macaddr @@ -61039,7 +61563,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /vlans
    @@ -61067,17 +61591,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    returns vlan
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    returns sriov-vf

    +

    returns vlan

    @@ -61108,22 +61632,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -61142,10 +61650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -61364,36 +61872,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    macaddr @@ -61426,44 +61904,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vlan-id-inner -

    When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

    +

    Inner VLAN tag

    		 query - boolean + integer @@ -61471,10 +61919,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + vpn-id -

    Neutron network id of the interface

    +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -61510,7 +61958,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /vlan
    @@ -61538,17 +61986,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/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 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 sriov-vf

    +

    create or update an existing vlan

    @@ -61557,13 +62005,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    sriov-vf object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

    - /sriov-vf + /vlan
    @@ -61596,22 +62044,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -61630,10 +62062,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -61675,23 +62107,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    update an existing vlan
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    delete an existing sriov-vf

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -61721,22 +62165,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -61755,10 +62183,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -61769,22 +62197,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -61816,35 +62228,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    delete an existing vlan
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vlan

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -61879,7 +62279,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 given to the interface

    		 path @@ -61892,10 +62292,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -61908,12 +62308,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + resource-version -

    PCI ID used to identify the sriov-vf

    +

    resource-version for concurrency

    		pathquery string @@ -61953,24 +62353,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -61999,22 +62394,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -62033,98 +62412,10 @@ 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/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 + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -62137,10 +62428,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -62361,10 +62652,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + macaddr -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    MAC address for the interface

    		 query @@ -62376,10 +62667,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + network-name -

    ID of interface

    +

    Name of the network

    		 query @@ -62391,10 +62682,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vlan-id-inner -

    MAC address for the interface

    +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -62406,10 +62712,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vlan-id-inner -

    Name of the network

    +

    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 @@ -62445,7 +62781,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /l3-interface-ipv4-address-list
    @@ -62473,19 +62809,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    returns vlan

    +

    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/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    @@ -62514,22 +62867,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -62564,293 +62901,288 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    -     		query - string - - -
    - regional-resource-zone - -

    Regional way of organizing pservers, source of truth should define values

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - in-maint - - query - boolean - - -
    - is-closed-loop-disabled - - query - boolean - - -
    - persona-model-id + l3-interface-ipv4-address -

    the ASDC model id for this resource or service model.

    +

    IP address

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    + Tags: + Network +
    +
    +
    +

    update an existing l3-interface-ipv4-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + - + - + + +
    - persona-model-version + vnf-id -

    the ASDC model version for this resource or service model.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - widget-model-id + interface-name -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Name given to the interface

    		querypath string +
    - widget-model-version + vlan-interface -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    String that identifies the interface

    		querypath string +
    - interface-id + l3-interface-ipv4-address -

    ID of interface

    +

    IP address

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - + - + - + - + - - - - - - - @@ -62869,29 +63202,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -62914,17 +63224,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    create or update an existing vlan

    +

    see node definition for valid relationships

    @@ -62933,13 +63243,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /vlan + /relationship
    @@ -62977,7 +63287,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-role + vnf-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - interface-id + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - macaddr + vlan-interface -

    MAC address for the interface

    +

    String that identifies the interface

    		querypath string +
    - network-name + l3-interface-ipv4-address -

    Name of the network

    +

    IP address

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id + resource-version -

    This indicates the customers VPN ID associated with this vlan

    +

    resource-version for concurrency

    		 query @@ -62858,6 +63190,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    -

    Name that identifies the link aggregate interface

    +

    Name given to the interface

    		 path @@ -62990,10 +63300,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -63006,10 +63316,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -63051,17 +63361,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 vlan

    +

    delete an existing relationship

    @@ -63097,22 +63407,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -63147,12 +63441,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -63192,17 +63486,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-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-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-ipv4-address-list

    +

    returns l3-interface-ipv6-address-list

    @@ -63233,22 +63527,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -63283,7 +63561,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -63505,36 +63783,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    macaddr @@ -63666,7 +63914,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -63694,17 +63942,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/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-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-ipv4-address-list

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -63713,13 +63961,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
    @@ -63752,22 +64000,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -63802,7 +64034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -63847,23 +64079,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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-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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -63898,7 +64142,116 @@ 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 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 @@ -63943,7 +64296,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -64004,11 +64357,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -64023,7 +64376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -64062,22 +64415,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -64112,7 +64449,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -64157,11 +64494,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -64203,22 +64540,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    interface-name @@ -64253,7 +64574,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + l3-interface-ipv6-address

    IP address

    @@ -64298,19 +64619,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -64344,7 +64682,100 @@ 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 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 @@ -64387,12 +64818,68 @@ 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 lag-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

    + Tags: + Network +
    +
    +
    +

    returns lag-interfaces

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv6-address + vnf-id -

    IP address

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -64596,156 +65083,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - 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 - - -
    @@ -64772,7 +65109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /lag-interfaces
    @@ -64800,36 +65137,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns lag-interface
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns lag-interface

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -64876,199 +65196,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - -
    - interface-name + vnf-name -

    Name given to the interface

    +

    Name of VNF.

    		pathquery string -
    - vlan-interface + vnf-name2 -

    String that identifies the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-type -

    IP address

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery 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 + service-id -

    Unique id of VNF. This is unique across the graph.

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		pathquery string -
    - interface-name + regional-resource-zone -

    Name that identifies the link aggregate interface

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - interface-name + prov-status -

    Name given to the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - vlan-interface + heat-stack-id -

    String that identifies the interface

    +

    Heat stack id corresponding to this instance, managed by MSO

    		pathquery string -
    - l3-interface-ipv6-address + in-maint -

    IP address

    		pathquery - string + boolean -
    - resource-version + is-closed-loop-disabled -

    resource-version for concurrency

    +     		query + boolean + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    		 query @@ -65076,160 +65340,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    see node definition for valid relationships

    - -
    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - + - + - + - + - + @@ -65241,6 +65426,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interface +
    +
    +
    + +
    default @@ -65263,23 +65471,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    create or update an existing lag-interface
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing relationship

    +

    create or update an existing lag-interface

    application/json application/xml

    +
    +
    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    - vnf-id + persona-model-version -

    Unique id of VNF. This is unique across the graph.

    +

    the ASDC model version for this resource or service model.

    		pathquery string -
    - interface-name + widget-model-id -

    Name that identifies the link aggregate interface

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		pathquery string -
    - interface-name + widget-model-version -

    Name given to the interface

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		pathquery string -
    - vlan-interface + interface-id -

    String that identifies the interface

    +

    ID of interface

    		pathquery string -
    - l3-interface-ipv6-address + interface-role -

    IP address

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    @@ -65325,54 +65545,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address - -

    IP address

    -     		path - string - - - -
    @@ -65404,17 +65576,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    update an existing lag-interface
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing lag-interface

    @@ -65423,13 +65595,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

    +

    lag-interface object that needs to be created or updated.

    - /relationship + /lag-interface
    @@ -65478,38 +65650,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    @@ -65541,17 +65681,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    delete an existing lag-interface
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing lag-interface

    @@ -65605,133 +65745,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - 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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - + - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - interface-name + resource-version -

    Name that identifies the link aggregate interface

    +

    resource-version for concurrency

    		pathquery string @@ -65771,24 +65790,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -65833,78 +65847,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns 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 @@ -66098,6 +66040,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    @@ -66124,7 +66096,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /licenses + /l-interfaces
    @@ -66152,17 +66124,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns license
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    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 license

    +

    returns l-interface

    @@ -66195,10 +66167,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -66211,10 +66183,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name given to the interface

    		 path @@ -66418,148 +66390,79 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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

    -

    -
    -
    -
    -
    - /license -
    -
    -
    -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + @@ -66571,6 +66474,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interface +
    +
    +
    + +
    default @@ -66593,23 +66519,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing license
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    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
    -

    delete an existing license

    +

    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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    - vnf-id + interface-id -

    Unique id of VNF. This is unique across the graph.

    +

    ID of interface

    		pathquery string -
    - group-uuid + interface-role -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - resource-uuid + interface-id -

    Unique ID of a license resource.

    +

    ID of interface

    		pathquery + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query string -
    @@ -66641,10 +66579,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - group-uuid + interface-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -66657,10 +66595,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name given to the interface

    		 path @@ -66671,22 +66609,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -66718,17 +66640,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l-interface

    @@ -66737,13 +66659,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

    +

    l-interface object that needs to be created or updated.

    - /relationship + /l-interface
    @@ -66778,10 +66700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -66794,10 +66716,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name given to the interface

    		 path @@ -66839,17 +66761,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l-interface

    @@ -66887,10 +66809,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -66903,10 +66825,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name given to the interface

    		 path @@ -66917,6 +66839,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -66948,36 +66886,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    returns l3-interface-ipv4-address-list

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -67006,73 +66927,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - -
    - vnf-id + interface-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name that identifies the link aggregate interface

    		 path @@ -67083,68 +66943,28 @@ 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 vf-modules
    -

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

    - Tags: - Network -
    -
    -
    -

    returns vf-modules

    - -
    -
    - - - - - - - - - - - + + + + + + + - -
    - vnf-id + interface-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -67348,301 +67168,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 - - -
    - persona-model-id - -

    the ASDC model id for this resource or service model.

    -     		query - string - - -
    - persona-model-version - -

    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 + interface-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    ID of interface

    		 query @@ -67654,10 +67185,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-name + interface-role -

    Name of vf-module

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -67669,10 +67200,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-id -

    Heat stack id corresponding to this instance.

    +

    ID of interface

    		 query @@ -67684,10 +67215,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -67699,10 +67230,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -67714,14 +67245,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vlan-id-inner -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Inner VLAN tag

    		 query - string + integer @@ -67729,10 +67260,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + neutron-network-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -67744,10 +67275,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-service-instance-fqdn + neutron-subnet-id -

    the Contrail unique ID for a service-instance

    +

    Neutron id of subnet that address belongs to

    		 query @@ -67783,7 +67314,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vf-module + /l3-interface-ipv4-address-list
    @@ -67811,17 +67342,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vf-module
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    +
    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 vf-module

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -67830,13 +67361,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vf-module object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /vf-module + /l3-interface-ipv4-address-list
    @@ -67871,10 +67402,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-id + interface-name -

    Unique ID of vf-module.

    +

    Name that identifies the link aggregate interface

    		 path @@ -67885,73 +67416,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + interface-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name given to the interface

    		 path @@ -67964,10 +67434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-id + l3-interface-ipv4-address -

    Unique ID of vf-module.

    +

    IP address

    		 path @@ -67978,22 +67448,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -68025,17 +67479,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv4-address-list

    @@ -68044,13 +67498,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv4-address-list
    @@ -68085,10 +67539,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-id + interface-name -

    Unique ID of vf-module.

    +

    Name that identifies the link aggregate interface

    		 path @@ -68099,73 +67553,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - -
    - vnf-id + interface-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name given to the interface

    		 path @@ -68178,10 +67571,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-module-id + l3-interface-ipv4-address -

    Unique ID of vf-module.

    +

    IP address

    		 path @@ -68223,83 +67616,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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
    -

    returns instance-group

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -68314,10 +67648,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + @@ -68382,29 +67735,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /instance-group -
    -
    -
    - -
    default @@ -68427,17 +67757,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing instance-group
    -

    PUT /network/instance-groups/instance-group/{id}

    +
    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
    -

    create or update an existing instance-group

    +

    see node definition for valid relationships

    @@ -68446,13 +67776,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    instance-group object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /instance-group + /relationship
    @@ -68471,10 +67801,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    - id + vnf-id -

    Instance Group ID, UUID assigned to this instance.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -68330,40 +67664,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - description + interface-name -

    Descriptive text to help identify the usage of this instance-group

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - type + interface-name -

    Only valid value today is lower case ha for high availability

    +

    Name given to the interface

    		querypath string +
    - sub-type + l3-interface-ipv4-address -

    Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

    +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -68371,6 +67723,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - id + vnf-id -

    Instance Group ID, UUID assigned to this instance.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -68485,73 +67815,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing instance-group
    -

    DELETE /network/instance-groups/instance-group/{id}

    - Tags: - Network -
    -
    -
    -

    delete an existing instance-group

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - id + interface-name -

    Instance Group ID, UUID assigned to this instance.

    +

    Name that identifies the link aggregate interface

    		 path @@ -68564,12 +67833,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -68578,85 +67847,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - id + l3-interface-ipv4-address -

    Instance Group ID, UUID assigned to this instance.

    +

    IP address

    		 path @@ -68698,11 +67894,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
    @@ -68730,10 +67926,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - id + vnf-id -

    Instance Group ID, UUID assigned to this instance.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -68744,132 +67940,44 @@ 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 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 + interface-name -

    UUID of this configuration

    +

    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 @@ -68889,29 +67997,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /ipsec-configuration -
    -
    -
    - -
    default @@ -68934,36 +68019,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing ipsec-configuration
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    +
    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
    -

    create or update an existing ipsec-configuration

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    -
    -

    ipsec-configuration object that needs to be created or updated

    -

    -
    -
    -
    -
    - /ipsec-configuration -
    -
    -
    -
    @@ -68978,10 +68046,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -68992,8 +68060,369 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 + + +
    + 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 + + +
    @@ -69001,6 +68430,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -69023,23 +68475,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing ipsec-configuration
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    +
    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
    -

    delete an existing ipsec-configuration

    +

    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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -69055,10 +68519,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -69071,12 +68535,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -69116,17 +68612,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -69135,13 +68631,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -69160,10 +68656,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + 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 @@ -69205,17 +68749,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

    +
    delete 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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -69237,10 +68781,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -69251,68 +68795,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns vig-servers
    -

    GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

    - Tags: - Network -
    -
    -
    -

    returns vig-servers

    - -
    -
    - - - - - - - - - - - - -
    - ipsec-configuration-id + interface-name -

    UUID of this configuration

    +

    Name that identifies the link aggregate interface

    		 path @@ -69323,91 +68811,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 + interface-name -

    UUID of this configuration

    +

    Name given to the interface

    		 path @@ -69420,10 +68829,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + l3-interface-ipv6-address -

    indicates whether the VIG is for AVPN or INTERNET

    +

    IP address

    		 path @@ -69434,6 +68843,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -69443,29 +68868,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vig-server -
    -
    -
    - -
    default @@ -69488,17 +68890,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vig-server
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    +
    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
    -

    create or update an existing vig-server

    +

    see node definition for valid relationships

    @@ -69507,13 +68909,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vig-server object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /vig-server + /relationship
    @@ -69532,10 +68934,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -69548,10 +68950,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    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 @@ -69593,17 +69027,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vig-server
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    +
    delete an existing 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 vig-server

    +

    delete an existing relationship

    @@ -69625,10 +69059,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -69641,10 +69075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name that identifies the link aggregate interface

    		 path @@ -69657,12 +69091,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -69702,11 +69152,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -69721,7 +69171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -69746,10 +69196,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -69762,10 +69212,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -69807,11 +69273,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -69839,10 +69305,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipsec-configuration-id + vnf-id -

    UUID of this configuration

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -69855,10 +69321,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vig-address-type + interface-name -

    indicates whether the VIG is for AVPN or INTERNET

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -69900,81 +69382,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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 l3-network

    +

    returns sriov-vfs

    @@ -69991,10 +69409,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -70007,25 +69425,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-name -

    Name of the network, governed by some naming convention..

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - network-role + interface-name -

    Role the network plans - who defines these values?

    +

    Name given to the interface

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -70037,10 +69472,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-name2 -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    Alternate name of VNF.

    		 query @@ -70052,10 +69487,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vnf-type -

    Heat stack id corresponding to this instance, managed by MSO

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -70067,10 +69502,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + service-id -

    Contrail FQDN for the network

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -70082,10 +69517,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + regional-resource-zone -

    the ASDC model id for this resource or service model.

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -70097,10 +69532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + prov-status -

    the ASDC model version for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -70112,10 +69547,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + heat-stack-id -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -70127,10 +69562,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + in-maint -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    		 query @@ -70140,13 +69603,133 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    +
    + persona-model-version + +

    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 + + +
    + 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 +

    @@ -70166,7 +69749,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-network + /sriov-vfs
    @@ -70194,36 +69777,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-network
    -

    PUT /network/l3-networks/l3-network/{network-id}

    +
    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
    -

    create or update an existing l3-network

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-network object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-network -
    -
    -
    -
    @@ -70238,10 +69804,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -70252,73 +69818,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing l3-network
    -

    DELETE /network/l3-networks/l3-network/{network-id}

    - Tags: - Network -
    -
    -
    -

    delete an existing l3-network

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - -
    - network-id + interface-name -

    Network ID, should be uuid. Unique across A&AI.

    +

    Name that identifies the link aggregate interface

    		 path @@ -70331,12 +69836,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -70345,68 +69850,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns ctag-assignments
    -

    GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

    - Tags: - Network -
    -
    -
    -

    returns ctag-assignments

    - -
    -
    - - - - - - - - - - - + + + + + + + - -
    - network-id + pci-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -70419,10 +69868,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vnf-name -

    Name of the network, governed by some naming convention..

    +

    Name of VNF.

    		 query @@ -70434,10 +69883,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + vnf-name2 -

    Role the network plans - who defines these values?

    +

    Alternate name of VNF.

    		 query @@ -70449,10 +69898,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + vnf-type -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -70464,10 +69913,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + service-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -70479,10 +69928,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + regional-resource-zone -

    Contrail FQDN for the network

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -70494,10 +69943,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + prov-status -

    the ASDC model id for this resource or service model.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -70509,10 +69958,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + heat-stack-id -

    the ASDC model version for this resource or service model.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -70524,14 +69973,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + in-maint -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query - string + boolean @@ -70539,10 +69987,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + is-closed-loop-disabled -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +     		query + boolean + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    		 query @@ -70552,123 +70014,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 + persona-model-version -

    Network ID, should be uuid. Unique across A&AI.

    +

    the ASDC model version for this resource or service model.

    		pathquery string -
    - vlan-id-inner + widget-model-id -

    id.

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		pathquery - integer + string -
    - network-name + widget-model-version -

    Name of the network, governed by some naming convention..

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -70680,10 +70061,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + interface-id -

    Role the network plans - who defines these values?

    +

    ID of interface

    		 query @@ -70695,10 +70076,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + interface-role -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -70710,10 +70091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    ID of interface

    		 query @@ -70725,10 +70106,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + macaddr -

    Contrail FQDN for the network

    +

    MAC address for the interface

    		 query @@ -70740,10 +70121,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + network-name -

    the ASDC model id for this resource or service model.

    +

    Name of the network

    		 query @@ -70755,10 +70136,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + vf-vlan-filter -

    the ASDC model version for this resource or service model.

    +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		 query @@ -70770,10 +70151,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vf-mac-filter -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    		 query @@ -70785,10 +70166,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vf-vlan-strip -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    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 @@ -70824,7 +70220,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /ctag-assignment + /sriov-vf
    @@ -70852,17 +70248,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing ctag-assignment
    -

    PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    +
    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 ctag-assignment

    +

    create or update an existing sriov-vf

    @@ -70871,13 +70267,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    ctag-assignment object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /ctag-assignment + /sriov-vf
    @@ -70896,10 +70292,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -70912,14 +70308,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name that identifies the link aggregate interface

    		 path - integer + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string @@ -70957,23 +70385,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing ctag-assignment
    -

    DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    +
    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
    -

    delete an existing ctag-assignment

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -70989,10 +70429,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -71005,14 +70445,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name that identifies the link aggregate interface

    		 path - integer + string @@ -71021,12 +70461,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path string @@ -71066,35 +70522,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -71110,10 +70554,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -71126,87 +70570,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + interface-name -

    id.

    +

    Name that identifies the link aggregate interface

    		 path - integer + string
    -
    - -
    -

    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 + interface-name -

    Network ID, should be uuid. Unique across A&AI.

    +

    Name given to the interface

    		 path @@ -71219,14 +70602,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + pci-id -

    id.

    +

    PCI ID used to identify the sriov-vf

    		 path - integer + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string @@ -71264,11 +70663,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

    +

    PUT /network/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
    @@ -71283,7 +70682,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -71308,10 +70707,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    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 @@ -71353,11 +70800,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

    +

    DELETE /network/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
    @@ -71385,10 +70832,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    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 @@ -71430,17 +70925,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns segmentation-assignments
    -

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

    +
    returns 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 segmentation-assignments

    +

    returns vlans

    @@ -71457,10 +70952,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -71473,40 +70968,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-name -

    Name of the network, governed by some naming convention..

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - network-role + interface-name -

    Role the network plans - who defines these values?

    +

    Name given to the interface

    		querypath string +
    - service-id + vnf-name -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    Name of VNF.

    		 query @@ -71518,10 +71015,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vnf-name2 -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Alternate name of VNF.

    		 query @@ -71533,10 +71030,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + vnf-type -

    Contrail FQDN for the network

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -71548,10 +71045,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + service-id -

    the ASDC model id for this resource or service model.

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -71563,10 +71060,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + regional-resource-zone -

    the ASDC model version for this resource or service model.

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -71578,10 +71075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + prov-status -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -71593,10 +71090,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + heat-stack-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -71606,123 +71103,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 + in-maint -

    Network ID, should be uuid. Unique across A&AI.

    		pathquery - string + boolean -
    - segmentation-id + is-closed-loop-disabled -

    Route Table Reference id, UUID assigned to this instance.

    		pathquery - string + boolean -
    - network-name + persona-model-id -

    Name of the network, governed by some naming convention..

    +

    the ASDC model id for this resource or service model.

    		 query @@ -71734,10 +71148,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + persona-model-version -

    Role the network plans - who defines these values?

    +

    the ASDC model version for this resource or service model.

    		 query @@ -71749,10 +71163,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + widget-model-id -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -71764,10 +71178,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + widget-model-version -

    Heat stack id corresponding to this instance, managed by MSO

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -71779,10 +71193,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + interface-id -

    Contrail FQDN for the network

    +

    ID of interface

    		 query @@ -71794,10 +71208,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + interface-role -

    the ASDC model id for this resource or service model.

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -71809,10 +71223,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + interface-id -

    the ASDC model version for this resource or service model.

    +

    ID of interface

    		 query @@ -71824,10 +71238,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + macaddr -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    MAC address for the interface

    		 query @@ -71839,10 +71253,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + network-name -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Name of the network

    		 query @@ -71878,7 +71292,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /segmentation-assignment + /vlans
    @@ -71906,36 +71320,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing segmentation-assignment
    -

    PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    +
    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
    -

    create or update an existing segmentation-assignment

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    segmentation-assignment object that needs to be created or updated

    -

    -
    -
    -
    -
    - /segmentation-assignment -
    -
    -
    -
    @@ -71950,10 +71347,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -71966,10 +71363,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -71980,6 +71393,320 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + 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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    @@ -71989,6 +71716,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    default @@ -72011,23 +71761,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing segmentation-assignment
    -

    DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    +
    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
    -

    delete an existing segmentation-assignment

    +

    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/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -72043,10 +71805,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -72059,10 +71821,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name that identifies the link aggregate interface

    		 path @@ -72075,12 +71837,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string @@ -72120,17 +71898,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing vlan

    @@ -72139,13 +71917,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

    +

    vlan object that needs to be created or updated.

    - /relationship + /vlan
    @@ -72164,10 +71942,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -72180,10 +71958,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -72225,17 +72035,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing vlan

    @@ -72257,10 +72067,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -72273,10 +72083,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - segmentation-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -72287,6 +72129,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -72318,17 +72176,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns subnets
    -

    GET /network/l3-networks/l3-network/{network-id}/subnets

    +
    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 subnets

    +

    returns l3-interface-ipv4-address-list

    @@ -72345,10 +72203,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -72361,40 +72219,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + interface-name -

    Name of the network, governed by some naming convention..

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - network-role + interface-name -

    Role the network plans - who defines these values?

    +

    Name given to the interface

    		querypath string +
    - service-id + vlan-interface -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -72406,10 +72298,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vnf-name2 -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Alternate name of VNF.

    		 query @@ -72421,10 +72313,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + vnf-type -

    Contrail FQDN for the network

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -72436,10 +72328,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + service-id -

    the ASDC model id for this resource or service model.

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -72451,10 +72343,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + regional-resource-zone -

    the ASDC model version for this resource or service model.

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -72466,10 +72358,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + prov-status -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -72481,10 +72373,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + heat-stack-id -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -72494,123 +72386,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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 + in-maint -

    Network ID, should be uuid. Unique across A&AI.

    		pathquery + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query string -
    - subnet-id + persona-model-version -

    Subnet ID, should be UUID.

    +

    the ASDC model version for this resource or service model.

    		pathquery string -
    - network-name + widget-model-id -

    Name of the network, governed by some naming convention..

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -72622,10 +72461,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-role + widget-model-version -

    Role the network plans - who defines these values?

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -72637,10 +72476,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + interface-id -

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +

    ID of interface

    		 query @@ -72652,10 +72491,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + interface-role -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -72667,10 +72506,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - contrail-network-fqdn + interface-id -

    Contrail FQDN for the network

    +

    ID of interface

    		 query @@ -72682,10 +72521,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-id + macaddr -

    the ASDC model id for this resource or service model.

    +

    MAC address for the interface

    		 query @@ -72697,10 +72536,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - persona-model-version + network-name -

    the ASDC model version for this resource or service model.

    +

    Name of the network

    		 query @@ -72712,10 +72551,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-id + vlan-id-inner -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -72727,10 +72581,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - widget-model-version + vlan-id-inner -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -72742,10 +72611,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-name + neutron-subnet-id -

    Name associated with the subnet.

    +

    Neutron id of subnet that address belongs to

    		 query @@ -72781,7 +72650,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /subnet + /l3-interface-ipv4-address-list
    @@ -72809,17 +72678,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing subnet
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    +
    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 subnet

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -72828,13 +72697,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    subnet object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /subnet + /l3-interface-ipv4-address-list
    @@ -72853,10 +72722,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -72869,10 +72738,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name that identifies the link aggregate interface

    		 path @@ -72883,73 +72752,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + interface-name -

    Network ID, should be uuid. Unique across A&AI.

    +

    Name given to the interface

    		 path @@ -72962,10 +72770,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + vlan-interface -

    Subnet ID, should be UUID.

    +

    String that identifies the interface

    		 path @@ -72978,12 +72786,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -73023,17 +72831,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv4-address-list

    @@ -73042,13 +72850,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv4-address-list
    @@ -73067,10 +72875,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -73083,10 +72891,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    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 @@ -73128,17 +72984,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l3-interface-ipv4-address-list

    @@ -73160,10 +73016,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-id + vnf-id -

    Network ID, should be uuid. Unique across A&AI.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -73176,10 +73032,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - subnet-id + interface-name -

    Subnet ID, should be UUID.

    +

    Name that identifies the link aggregate interface

    		 path @@ -73190,132 +73046,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + interface-name -

    Alphabetical concatenation of lag-interface names

    +

    Name given to the interface

    		 path @@ -73326,108 +73062,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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

    -

    -
    -
    -
    -
    - /lag-link -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - link-name + vlan-interface -

    Alphabetical concatenation of lag-interface names

    +

    String that identifies the interface

    		 path @@ -73438,73 +73078,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing lag-link
    -

    DELETE /network/lag-links/lag-link/{link-name}

    - Tags: - Network -
    -
    -
    -

    delete an existing lag-link

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - link-name + l3-interface-ipv4-address -

    Alphabetical concatenation of lag-interface names

    +

    IP address

    		 path @@ -73562,11 +73141,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -73581,7 +73160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -73606,10 +73185,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id -

    Alphabetical concatenation of lag-interface names

    +

    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 @@ -73651,11 +73294,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -73683,10 +73326,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id -

    Alphabetical concatenation of lag-interface names

    +

    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 @@ -73728,81 +73435,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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 logical-link

    +

    returns l3-interface-ipv6-address-list

    @@ -73819,10 +73462,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    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 @@ -73833,6 +73540,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + service-id + +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +     		query + string + + +
    + regional-resource-zone + +

    Regional way of organizing pservers, source of truth should define values

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    persona-model-id @@ -73895,10 +73735,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    ID of interface

    		 query @@ -73910,10 +73750,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-id + interface-role -

    UUID of the logical-link, SDNC generates this.

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -73925,10 +73765,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - circuit-id + interface-id -

    Circuit id

    +

    ID of interface

    		 query @@ -73940,10 +73780,100 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - purpose + macaddr -

    Reason for this entity, role it is playing

    +

    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 @@ -73979,7 +73909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /logical-link + /l3-interface-ipv6-address-list
    @@ -74007,17 +73937,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing logical-link
    -

    PUT /network/logical-links/logical-link/{link-name}

    +
    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 logical-link

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -74026,13 +73956,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    logical-link object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /logical-link + /l3-interface-ipv6-address-list
    @@ -74051,10 +73981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -74065,73 +73995,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing logical-link
    -

    DELETE /network/logical-links/logical-link/{link-name}

    - Tags: - Network -
    -
    -
    -

    delete an existing logical-link

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - link-name + interface-name -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    Name that identifies the link aggregate interface

    		 path @@ -74144,12 +74013,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -74189,17 +74090,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -74208,13 +74109,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -74233,10 +74134,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    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 @@ -74278,17 +74243,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -74310,10 +74275,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + vnf-id -

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -74324,132 +74289,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + interface-name -

    Unique id of multicast configuration.

    +

    Name that identifies the link aggregate interface

    		 path @@ -74460,108 +74305,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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

    -

    -
    -
    -
    -
    - /multicast-configuration -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - multicast-configuration-id + interface-name -

    Unique id of multicast configuration.

    +

    Name given to the interface

    		 path @@ -74572,73 +74321,28 @@ 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 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 + vlan-interface -

    Unique id of multicast configuration.

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -74696,11 +74400,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -74715,7 +74419,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -74740,10 +74444,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - multicast-configuration-id + vnf-id -

    Unique id of multicast configuration.

    +

    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 @@ -74785,11 +74553,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -74817,10 +74585,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - multicast-configuration-id + vnf-id -

    Unique id of multicast configuration.

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -74831,132 +74599,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + @@ -74991,29 +74672,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /network-policy -
    -
    -
    - -
    default @@ -75036,17 +74694,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing network-policy
    -

    PUT /network/network-policies/network-policy/{network-policy-id}

    +
    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
    -

    create or update an existing network-policy

    +

    see node definition for valid relationships

    @@ -75055,13 +74713,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    network-policy object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /network-policy + /relationship
    @@ -75080,10 +74738,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - network-policy-id + interface-name -

    UUID representing unique key to this instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -74969,17 +74617,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-fqdn + interface-name -

    Contrail FQDN for the policy

    +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string +
    - network-policy-id + vnf-id -

    UUID representing unique key to this instance

    +

    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 @@ -75125,17 +74831,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing network-policy
    -

    DELETE /network/network-policies/network-policy/{network-policy-id}

    +
    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 network-policy

    +

    delete an existing relationship

    @@ -75157,10 +74863,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-id + vnf-id -

    UUID representing unique key to this instance

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -75173,12 +74879,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string @@ -75218,11 +74956,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -75237,7 +74975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

    @@ -75262,10 +75000,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-id + vnf-id -

    UUID representing unique key to this instance

    +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -75307,11 +75061,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -75339,10 +75093,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-policy-id + vnf-id -

    UUID representing unique key to this instance

    +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -75384,81 +75154,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    returns licenses
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

    Tags: Network
    -

    returns newvce

    +

    returns licenses

    @@ -75475,10 +75181,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -75534,12 +75240,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + service-id + +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    +     		query + 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 VNF by BAU Service Assurance systems.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -75564,6 +75300,94 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + in-maint + + query + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 + + +
    @@ -75590,7 +75414,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /newvce + /licenses
    @@ -75618,36 +75442,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing newvce
    -

    PUT /network/newvces/newvce/{vnf-id2}

    +
    returns license
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    create or update an existing newvce

    +

    returns license

    -
    - -

    application/json application/xml -

    -
    -
    -

    newvce object that needs to be created or updated

    -

    -
    -
    -
    -
    - /newvce -
    -
    -
    -
    @@ -75662,10 +75469,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -75676,73 +75483,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing newvce
    -

    DELETE /network/newvces/newvce/{vnf-id2}

    - Tags: - Network -
    -
    -
    -

    delete an existing newvce

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - -
    - vnf-id2 + group-uuid -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -75755,84 +75501,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + resource-uuid -

    resource-version for concurrency

    +

    Unique ID of a license resource.

    		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

    -     		pathpath string @@ -75888,10 +75562,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + service-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -75903,10 +75577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + regional-resource-zone -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -75916,123 +75590,12 @@ 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/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 + prov-status -

    Name of VNF.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -76044,10 +75607,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name2 + heat-stack-id -

    Alternate name of VNF.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -76059,14 +75622,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + in-maint -

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 + boolean @@ -76074,14 +75636,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + is-closed-loop-disabled -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query - string + boolean @@ -76089,10 +75650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + persona-model-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    the ASDC model id for this resource or service model.

    		 query @@ -76104,10 +75665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + persona-model-version -

    ID of interface

    +

    the ASDC model version for this resource or service model.

    		 query @@ -76119,10 +75680,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + widget-model-id -

    MAC address for the interface

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -76134,10 +75695,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + widget-model-version -

    Name of the network

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -76173,7 +75734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /license
    @@ -76201,17 +75762,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l-interface
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    +
    create or update an existing license
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    create or update an existing l-interface

    +

    create or update an existing license

    @@ -76220,13 +75781,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

    +

    license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)

    - /l-interface + /license
    @@ -76245,10 +75806,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -76261,10 +75822,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    +     		path + string + + + +
    + resource-uuid + +

    Unique ID of a license resource.

    		 path @@ -76306,23 +75883,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    +
    update an existing license
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    delete an existing l-interface

    +

    update an existing license

    application/json application/xml

    +
    +
    +

    license object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /license +
    +
    +
    @@ -76338,10 +75927,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -76354,10 +75943,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76370,12 +75959,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + resource-uuid -

    resource-version for concurrency

    +

    Unique ID of a license resource.

    		querypath string @@ -76415,19 +76004,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    delete an existing license
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing license

    +
    + +

    application/json application/xml +

    +
    @@ -76442,10 +76036,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -76662,29 +76107,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv4-address-list -
    -
    -
    - -
    default @@ -76707,17 +76129,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    @@ -76726,13 +76148,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)

    - /l3-interface-ipv4-address-list + /relationship
    @@ -76751,10 +76173,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -76458,10 +76052,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76474,10 +76068,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-uuid -

    IP address

    +

    Unique ID of a license resource.

    		 path @@ -76490,160 +76084,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - 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 + resource-version -

    Neutron id of subnet that address belongs to

    +

    resource-version for concurrency

    		 query @@ -76651,6 +76095,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -76767,10 +76189,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76783,10 +76205,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-uuid -

    IP address

    +

    Unique ID of a license resource.

    		 path @@ -76828,17 +76250,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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 l3-interface-ipv4-address-list

    +

    delete an existing relationship

    @@ -76860,10 +76282,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -76876,10 +76298,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -76892,10 +76314,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-uuid -

    IP address

    +

    Unique ID of a license resource.

    		 path @@ -76906,22 +76328,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -76953,11 +76359,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    Tags: Network
    @@ -76972,7 +76378,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)

    @@ -76997,42 +76403,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + vnf-id -

    IP address

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -77074,11 +76448,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

    Tags: Network
    @@ -77106,42 +76480,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + vnf-id -

    IP address

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -77183,17 +76525,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns vf-modules
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns vf-modules

    @@ -77210,10 +76552,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -77226,42 +76568,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name given to the interface

    +

    Name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-name2 -

    IP address

    +

    Alternate name of VNF.

    		pathquery string -
    - vnf-name + vnf-type -

    Name of VNF.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -77273,10 +76613,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name2 + service-id -

    Alternate name of VNF.

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		 query @@ -77288,10 +76628,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + regional-resource-zone -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -77306,7 +76646,7 @@ 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.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -77333,14 +76673,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + in-maint -

    ID of interface

    		 query - string + boolean @@ -77348,14 +76687,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + is-closed-loop-disabled -

    MAC address for the interface

    		 query - string + boolean @@ -77363,10 +76701,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + persona-model-id -

    Name of the network

    +

    the ASDC model id for this resource or service model.

    		 query @@ -77378,14 +76716,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + persona-model-version -

    Inner VLAN tag

    +

    the ASDC model version for this resource or service model.

    		 query - integer + string @@ -77393,10 +76731,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + widget-model-id -

    Neutron network id of the interface that address belongs to

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -77408,10 +76746,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + widget-model-version -

    Neutron id of subnet that address belongs to

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -77447,7 +76785,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /vf-modules
    @@ -77475,36 +76813,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns vf-module
    +

    GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns vf-module

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -77519,10 +76840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -77535,10 +76856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vf-module-id -

    Name given to the interface

    +

    Unique ID of vf-module.

    		 path @@ -77551,135 +76872,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vnf-name -

    IP address

    +

    Name of VNF.

    		pathquery 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 + vnf-name2 -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Alternate name of VNF.

    		pathquery string -
    - interface-name + vnf-type -

    Name given to the interface

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery string -
    - l3-interface-ipv6-address + service-id -

    IP address

    +

    Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

    		pathquery string -
    - resource-version + regional-resource-zone -

    resource-version for concurrency

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -77687,250 +76943,265 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + - -
    - vnf-id2 + prov-status -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - interface-name + heat-stack-id -

    Name given to the interface

    +

    Heat stack id corresponding to this instance, managed by MSO

    		pathquery string -
    - l3-interface-ipv6-address + in-maint -

    IP address

    		pathquery + boolean + + +
    + is-closed-loop-disabled + + query + boolean + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query 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 + persona-model-version -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    the ASDC model version for this resource or service model.

    		pathquery string -
    - interface-name + widget-model-id -

    Name given to the interface

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		pathquery string -
    - l3-interface-ipv6-address + widget-model-version -

    IP address

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		pathquery string -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default +
    + vf-module-name + +

    Name of vf-module

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance.

    +     		query + string + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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
    @@ -77951,17 +77222,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    create or update an existing vf-module
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing vf-module

    @@ -77970,13 +77241,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

    +

    vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    - /relationship + /vf-module
    @@ -77995,10 +77266,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -78011,10 +77282,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vf-module-id -

    Name given to the interface

    +

    Unique ID of vf-module.

    		 path @@ -78056,23 +77327,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    update an existing vf-module
    +

    PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing vf-module

    application/json application/xml

    +
    +
    +

    vf-module object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vf-module +
    +
    +
    @@ -78088,10 +77371,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -78104,10 +77387,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vf-module-id -

    Name given to the interface

    +

    Unique ID of vf-module.

    		 path @@ -78149,19 +77432,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    delete an existing vf-module
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

    Tags: Network
    -

    returns sriov-vfs

    +

    delete an existing vf-module

    +
    + +

    application/json application/xml +

    +
    @@ -78176,10 +77464,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - + +
    - vnf-id2 + vnf-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -78192,10 +77480,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vf-module-id -

    Name given to the interface

    +

    Unique ID of vf-module.

    		 path @@ -78208,55 +77496,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - prov-status + resource-version -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    resource-version for concurrency

    		 query @@ -78264,72 +77507,252 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/generic-vnfs/generic-vnf/{vnf-id}/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/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + +
    - heat-stack-id + vnf-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - interface-id + vf-module-id -

    ID of interface

    +

    Unique ID of vf-module.

    		querypath string +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + - +
    - macaddr + vnf-id -

    MAC address for the interface

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - network-name + vf-module-id -

    Name of the network

    +

    Unique ID of vf-module.

    		querypath 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

    @@ -78352,7 +77775,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /instance-groups
    @@ -78380,17 +77803,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    returns instance-group
    +

    GET /network/instance-groups/instance-group/{id}

    Tags: Network
    -

    returns sriov-vf

    +

    returns instance-group

    @@ -78407,42 +77830,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id + id -

    PCI ID used to identify the sriov-vf

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -78455,130 +77846,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - 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 + description -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Descriptive text to help identify the usage of this instance-group

    		 query @@ -78590,10 +77861,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + type -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    Only valid value today is lower case ha for high availability

    		 query @@ -78605,25 +77876,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 + sub-type -

    Neutron network id of the interface

    +

    Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

    		 query @@ -78659,7 +77915,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /instance-group
    @@ -78687,17 +77943,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/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    create or update an existing instance-group
    +

    PUT /network/instance-groups/instance-group/{id}

    Tags: Network
    -

    create or update an existing sriov-vf

    +

    create or update an existing instance-group

    @@ -78706,13 +77962,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

    +

    instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)

    - /sriov-vf + /instance-group
    @@ -78731,42 +77987,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id + id -

    PCI ID used to identify the sriov-vf

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -78808,23 +78032,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing instance-group
    +

    PATCH /network/instance-groups/instance-group/{id}

    Tags: Network
    -

    delete an existing sriov-vf

    +

    update an existing instance-group

    application/json application/xml

    +
    +
    +

    instance-group object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /instance-group +
    +
    +
    @@ -78840,26 +78076,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name + id -

    Name given to the interface

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -78870,12 +78090,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing instance-group
    +

    DELETE /network/instance-groups/instance-group/{id}

    + Tags: + Network +
    +
    +
    +

    delete an existing instance-group

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pci-id + id -

    PCI ID used to identify the sriov-vf

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -78933,11 +78214,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

    Tags: Network
    @@ -78952,7 +78233,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)

    @@ -78977,42 +78258,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id + id -

    PCI ID used to identify the sriov-vf

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -79054,11 +78303,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

    Tags: Network
    @@ -79086,42 +78335,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - pci-id + id -

    PCI ID used to identify the sriov-vf

    +

    Instance Group ID, UUID assigned to this instance.

    		 path @@ -79163,17 +78380,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

    +
    returns ipsec-configurations
    +

    GET /network/ipsec-configurations

    Tags: Network
    -

    returns vlans

    +

    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

    @@ -79190,26 +78471,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name + ipsec-configuration-id -

    Name given to the interface

    +

    UUID of this configuration

    		 path @@ -79220,126 +78485,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -79366,7 +78511,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /ipsec-configuration
    @@ -79394,19 +78539,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlan
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing ipsec-configuration
    +

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    Tags: Network
    -

    returns vlan

    +

    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/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)

    +

    +
    +
    +
    +
    + /ipsec-configuration +
    +
    +
    +
    @@ -79421,42 +78583,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -79467,156 +78597,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -79626,29 +78606,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -79671,17 +78628,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing ipsec-configuration
    +

    PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    Tags: Network
    -

    create or update an existing vlan

    +

    update an existing ipsec-configuration

    @@ -79690,13 +78647,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    ipsec-configuration object that needs to be created or updated.

    - /vlan + /ipsec-configuration
    @@ -79715,42 +78672,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -79792,17 +78717,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    delete an existing ipsec-configuration
    +

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

    Tags: Network
    -

    delete an existing vlan

    +

    delete an existing ipsec-configuration

    @@ -79824,42 +78749,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -79917,19 +78810,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -79944,10 +78854,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - vnf-id2 + ipsec-configuration-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    UUID of this configuration

    		 path @@ -79958,12 +78868,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + ipsec-configuration-id -

    Name given to the interface

    +

    UUID of this configuration

    		 path @@ -79974,12 +78945,68 @@ 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 vig-servers
    +

    GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

    + Tags: + Network +
    +
    +
    +

    returns vig-servers

    + +
    +
    + + + + + + + + + + + + +
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -79990,12 +79017,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    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

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -80227,7 +79154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /vig-server
    @@ -80255,17 +79182,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing 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 l3-interface-ipv4-address-list

    +

    create or update an existing vig-server

    @@ -80274,13 +79201,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

    +

    vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

    - /l3-interface-ipv4-address-list + /vig-server
    @@ -80299,42 +79226,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - + + + + + + +
    - l3-interface-ipv4-address + ipsec-configuration-id -

    IP address

    +

    UUID of this configuration

    		 path @@ -80008,197 +79114,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    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 + vig-address-type -

    Neutron id of subnet that address belongs to

    +

    indicates whether the VIG is for AVPN or INTERNET

    		querypath string +
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -80347,10 +79242,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + vig-address-type -

    IP address

    +

    indicates whether the VIG is for AVPN or INTERNET

    		 path @@ -80392,23 +79287,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/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 vig-server
    +

    PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    update an existing vig-server

    application/json application/xml

    +
    +
    +

    vig-server object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vig-server +
    +
    +
    @@ -80424,10 +79331,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - vnf-id2 + ipsec-configuration-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    UUID of this configuration

    		 path @@ -80440,10 +79347,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vig-address-type -

    Name given to the interface

    +

    indicates whether the VIG is for AVPN or INTERNET

    		 path @@ -80454,12 +79361,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -80472,10 +79440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + vig-address-type -

    IP address

    +

    indicates whether the VIG is for AVPN or INTERNET

    		 path @@ -80533,11 +79501,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

    Tags: Network
    @@ -80552,7 +79520,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

    @@ -80577,42 +79545,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + ipsec-configuration-id -

    String that identifies the interface

    +

    UUID of this configuration

    		 path @@ -80625,10 +79561,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + vig-address-type -

    IP address

    +

    indicates whether the VIG is for AVPN or INTERNET

    		 path @@ -80670,11 +79606,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

    Tags: Network
    @@ -80702,10 +79638,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + ipsec-configuration-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    UUID of this configuration

    		 path @@ -80718,42 +79654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vig-address-type -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    +

    indicates whether the VIG is for AVPN or INTERNET

    		 path @@ -80795,17 +79699,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns l3-networks
    +

    GET /network/l3-networks

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    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

    @@ -80822,58 +79790,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + network-id -

    IP address

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -80886,25 +79806,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 + network-name -

    Alternate name of VNF.

    +

    Name of the network, governed by some naming convention..

    		 query @@ -80916,10 +79821,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + network-role -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Role the network plans - who defines these values?

    		 query @@ -80931,10 +79836,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + service-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    		 query @@ -80961,25 +79866,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + contrail-network-fqdn -

    MAC address for the interface

    +

    Contrail FQDN for the network

    		 query @@ -80991,10 +79881,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + persona-model-id -

    Name of the network

    +

    the ASDC model id for this resource or service model.

    		 query @@ -81006,25 +79896,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id + persona-model-version -

    This indicates the customers VPN ID associated with this vlan

    +

    the ASDC model version for this resource or service model.

    		 query @@ -81036,25 +79911,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 + widget-model-id -

    Neutron network id of the interface that address belongs to

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -81066,10 +79926,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + widget-model-version -

    Neutron id of subnet that address belongs to

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -81105,7 +79965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-network
    @@ -81133,17 +79993,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/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-network
    +

    PUT /network/l3-networks/l3-network/{network-id}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    create or update an existing l3-network

    @@ -81152,13 +80012,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)

    - /l3-interface-ipv6-address-list + /l3-network
    @@ -81177,10 +80037,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + network-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81191,12 +80051,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +
    +
    +
    +
    +
    + + + + + + + + + + + + +
    - interface-name + network-id -

    Name given to the interface

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81207,12 +80140,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing l3-network
    +

    DELETE /network/l3-networks/l3-network/{network-id}

    + Tags: + Network +
    +
    +
    +

    delete an existing l3-network

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + + + + + + + +
    - vlan-interface + network-id -

    String that identifies the interface

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81225,12 +80219,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -81270,24 +80264,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns ctag-assignments
    +

    GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    returns ctag-assignments

    -
    - -

    application/json application/xml -

    -
    @@ -81302,10 +80291,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -81389,6 +80449,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /ctag-assignments +
    +
    +
    + +
    default @@ -81411,36 +80494,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns ctag-assignment
    +

    GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns ctag-assignment

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    - vnf-id2 + network-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81318,58 +80307,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + network-name -

    Name given to the interface

    +

    Name of the network, governed by some naming convention..

    		pathquery string -
    - vlan-interface + network-role -

    String that identifies the interface

    +

    Role the network plans - who defines these values?

    		pathquery string -
    - l3-interface-ipv6-address + service-id -

    IP address

    +

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    		pathquery string -
    - resource-version + heat-stack-id -

    resource-version for concurrency

    +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + contrail-network-fqdn + +

    Contrail FQDN for the network

    +     		query + string + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 @@ -81377,7 +80438,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    @@ -81455,10 +80521,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -81526,6 +80695,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /ctag-assignment +
    +
    +
    + +
    default @@ -81548,23 +80740,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    create or update an existing ctag-assignment
    +

    PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    Tags: Network
    -

    delete an existing relationship

    +

    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/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

    +

    +
    +
    +
    +
    + /ctag-assignment +
    +
    +
    - vnf-id2 + network-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81471,14 +80537,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-id-inner -

    Name given to the interface

    +

    id.

    		 path - string + integer @@ -81487,34 +80553,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + network-name -

    String that identifies the interface

    +

    Name of the network, governed by some naming convention..

    		pathquery string -
    - l3-interface-ipv6-address + network-role -

    IP address

    +

    Role the network plans - who defines these values?

    		pathquery + 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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 -
    @@ -81580,42 +80784,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + network-id -

    String that identifies the interface

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81628,14 +80800,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-id-inner -

    IP address

    +

    id.

    		 path - string + integer @@ -81673,17 +80845,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    update an existing ctag-assignment
    +

    PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing ctag-assignment

    @@ -81692,13 +80864,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

    +

    ctag-assignment object that needs to be created or updated.

    - /relationship + /ctag-assignment
    @@ -81717,26 +80889,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 - -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    -     		path - string - - - -
    - interface-name + network-id -

    Name given to the interface

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81749,14 +80905,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vlan-id-inner -

    String that identifies the interface

    +

    id.

    		 path - string + integer @@ -81794,17 +80950,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    delete an existing ctag-assignment
    +

    DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing ctag-assignment

    @@ -81826,10 +80982,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + network-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81842,14 +80998,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-id-inner -

    Name given to the interface

    +

    id.

    		 path - string + integer @@ -81858,12 +81014,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-version -

    String that identifies the interface

    +

    resource-version for concurrency

    		pathquery string @@ -81903,11 +81059,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    +

    PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

    Tags: Network
    @@ -81922,7 +81078,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

    @@ -81947,10 +81103,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + network-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -81961,6 +81117,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-id-inner + +

    id.

    +     		path + integer + + + +
    @@ -81992,11 +81164,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    +

    DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

    Tags: Network
    @@ -82024,10 +81196,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id2 + network-id -

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82038,6 +81210,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-id-inner + +

    id.

    +     		path + integer + + + +
    @@ -82069,48 +81257,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns physical-links
    -

    GET /network/physical-links

    +
    see node definition for valid relationships
    +

    PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

    Tags: Network
    -

    returns physical-links

    +

    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/v9/NetworkL3NetworksL3Network.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + +
    + network-id + +

    Network ID, should be uuid. Unique across A&AI.

    +     		path + string + + + +
    +

    application/json application/xml

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /physical-links -
    -
    -
    - -
    default @@ -82133,19 +81346,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns physical-link
    -

    GET /network/physical-links/physical-link/{link-name}

    +
    delete an existing relationship
    +

    DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

    Tags: Network
    -

    returns physical-link

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -82160,10 +81378,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - link-name + network-id -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82174,21 +81392,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - circuit-id - -

    Circuit it

    -     		query - string - - -
    @@ -82198,42 +81401,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK +
    + default
    -
    +
    -

    successful operation

    +

    Response codes found in response codes.

    - -
    -
    - -
    - /physical-link -
    -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - +
    @@ -82243,36 +81423,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing physical-link
    -

    PUT /network/physical-links/physical-link/{link-name}

    +
    returns segmentation-assignments
    +

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

    Tags: Network
    -

    create or update an existing physical-link

    +

    returns segmentation-assignments

    -
    - -

    application/json application/xml -

    -
    -
    -

    physical-link object that needs to be created or updated

    -

    -
    -
    -
    -
    - /physical-link -
    -
    -
    -
    @@ -82287,10 +81450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - link-name + network-id -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82301,6 +81464,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + network-name + +

    Name of the network, governed by some naming convention..

    +     		query + string + + +
    + network-role + +

    Role the network plans - who defines these values?

    +     		query + string + + +
    + service-id + +

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + contrail-network-fqdn + +

    Contrail FQDN for the network

    +     		query + string + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 + + +
    @@ -82310,6 +81608,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /segmentation-assignments +
    +
    +
    + +
    default @@ -82332,24 +81653,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing physical-link
    -

    DELETE /network/physical-links/physical-link/{link-name}

    +
    returns segmentation-assignment
    +

    GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    Tags: Network
    -

    delete an existing physical-link

    +

    returns segmentation-assignment

    -
    - -

    application/json application/xml -

    -
    @@ -82364,10 +81680,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - link-name + network-id -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82380,12 +81696,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + segmentation-id -

    resource-version for concurrency

    +

    Route Table Reference id, UUID assigned to this instance.

    		querypath string @@ -82394,6 +81710,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + network-name + +

    Name of the network, governed by some naming convention..

    +     		query + string + + +
    + network-role + +

    Role the network plans - who defines these values?

    +     		query + string + + +
    + service-id + +

    Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + contrail-network-fqdn + +

    Contrail FQDN for the network

    +     		query + string + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 + + +
    @@ -82403,6 +81854,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /segmentation-assignment +
    +
    +
    + +
    default @@ -82425,17 +81899,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

    +
    create or update an existing segmentation-assignment
    +

    PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing segmentation-assignment

    @@ -82444,13 +81918,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

    +

    segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

    - /relationship + /segmentation-assignment
    @@ -82469,10 +81943,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - link-name + network-id -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Network ID, should be uuid. Unique across A&AI.

    +     		path + string + + + +
    + segmentation-id + +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -82514,23 +82004,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

    +
    update an existing segmentation-assignment
    +

    PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing segmentation-assignment

    application/json application/xml

    +
    +
    +

    segmentation-assignment object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /segmentation-assignment +
    +
    +
    @@ -82546,10 +82048,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - link-name + network-id -

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    +

    Network ID, should be uuid. Unique across A&AI.

    +     		path + string + + + +
    + segmentation-id + +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -82591,83 +82109,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    delete an existing segmentation-assignment
    +

    DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

    Tags: Network
    -

    returns pnf

    +

    delete an existing segmentation-assignment

    +
    + +

    application/json application/xml +

    +
    @@ -82682,10 +82141,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + @@ -82720,29 +82196,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /pnf -
    -
    -
    - -
    default @@ -82765,17 +82218,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing pnf
    -

    PUT /network/pnfs/pnf/{pnf-name}

    +
    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
    -

    create or update an existing pnf

    +

    see node definition for valid relationships

    @@ -82784,13 +82237,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    pnf object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

    - /pnf + /relationship
    @@ -82809,10 +82262,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82698,10 +82157,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + segmentation-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Route Table Reference id, UUID assigned to this instance.

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -82709,6 +82184,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    +     		path + string + + + +
    + segmentation-id + +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -82854,17 +82323,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing pnf
    -

    DELETE /network/pnfs/pnf/{pnf-name}

    +
    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 pnf

    +

    delete an existing relationship

    @@ -82886,10 +82355,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82902,12 +82371,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + segmentation-id -

    resource-version for concurrency

    +

    Route Table Reference id, UUID assigned to this instance.

    		querypath string @@ -82947,17 +82416,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

    +
    returns subnets
    +

    GET /network/l3-networks/l3-network/{network-id}/subnets

    Tags: Network
    -

    returns lag-interfaces

    +

    returns subnets

    @@ -82974,10 +82443,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -82990,10 +82459,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + network-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 @@ -83029,7 +82618,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interfaces + /subnets
    @@ -83057,17 +82646,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns lag-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    returns subnet
    +

    GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    Tags: Network
    -

    returns lag-interface

    +

    returns subnet

    @@ -83084,10 +82673,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -83100,10 +82689,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + subnet-id -

    Name that identifies the link aggregate interface

    +

    Subnet ID, should be UUID.

    		 path @@ -83116,10 +82705,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + network-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Name of the network, governed by some naming convention..

    		 query @@ -83131,10 +82720,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + network-role -

    ID of interface

    +

    Role the network plans - who defines these values?

    		 query @@ -83146,10 +82735,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + service-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    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 + + +
    + persona-model-id + +

    the ASDC model id for this resource or service model.

    +     		query + string + + +
    + persona-model-version + +

    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 @@ -83185,7 +82879,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /subnet
    @@ -83213,17 +82907,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    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 lag-interface

    +

    create or update an existing subnet

    @@ -83232,13 +82926,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

    +

    subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

    - /lag-interface + /subnet
    @@ -83257,10 +82951,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -83273,10 +82967,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + subnet-id -

    Name that identifies the link aggregate interface

    +

    Subnet ID, should be UUID.

    		 path @@ -83318,23 +83012,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing lag-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    +
    update an existing subnet
    +

    PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    Tags: Network
    -

    delete an existing lag-interface

    +

    update an existing subnet

    application/json application/xml

    +
    +
    +

    subnet object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /subnet +
    +
    +
    @@ -83350,10 +83056,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -83366,10 +83072,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + subnet-id -

    Name that identifies the link aggregate interface

    +

    Subnet ID, should be UUID.

    		 path @@ -83380,22 +83086,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -83427,19 +83117,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    +
    delete an existing subnet
    +

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

    Tags: Network
    -

    returns l-interfaces

    +

    delete an existing subnet

    +
    + +

    application/json application/xml +

    +
    @@ -83454,10 +83149,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -83538,29 +83204,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -83583,19 +83226,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    see node definition for valid relationships
    +

    PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    Tags: Network
    -

    returns l-interface

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -83470,10 +83165,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + subnet-id -

    Name that identifies the link aggregate interface

    +

    Subnet ID, should be UUID.

    		 path @@ -83486,40 +83181,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - interface-id + resource-version -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    resource-version for concurrency

    		 query @@ -83527,6 +83192,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -83610,10 +83270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + network-id -

    unique name of Physical Network Function.

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -83626,10 +83286,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + subnet-id -

    Name that identifies the link aggregate interface

    +

    Subnet ID, should be UUID.

    		 path @@ -83640,12 +83300,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
    - interface-name + network-id -

    Name given to the interface

    +

    Network ID, should be uuid. Unique across A&AI.

    		 path @@ -83658,92 +83379,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + subnet-id -

    MAC address for the interface

    +

    Subnet ID, should be UUID.

    		querypath 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

    + +
    +
    + + + + + + + + + + + - + @@ -83772,7 +83555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /lag-link
    @@ -83800,17 +83583,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    create or update an existing lag-link
    +

    PUT /network/lag-links/lag-link/{link-name}

    Tags: Network
    -

    create or update an existing l-interface

    +

    create or update an existing lag-link

    @@ -83819,13 +83602,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)

    - /l-interface + /lag-link
    @@ -83844,42 +83627,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - -
    - network-name + link-name -

    Name of the network

    +

    Alphabetical concatenation of lag-interface names

    		querypath string +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + link-name -

    Name given to the interface

    +

    Alphabetical concatenation of lag-interface names

    		 path @@ -83921,23 +83672,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    update an existing lag-link
    +

    PATCH /network/lag-links/lag-link/{link-name}

    Tags: Network
    -

    delete an existing l-interface

    +

    update an existing lag-link

    application/json application/xml

    +
    +
    +

    lag-link object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /lag-link +
    +
    +
    @@ -83953,26 +83716,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + link-name -

    Name that identifies the link aggregate interface

    +

    Alphabetical concatenation of lag-interface names

    		 path @@ -83983,12 +83730,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing lag-link
    +

    DELETE /network/lag-links/lag-link/{link-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing lag-link

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + +
    - interface-name + link-name -

    Name given to the interface

    +

    Alphabetical concatenation of lag-interface names

    		 path @@ -84046,19 +83854,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -84073,26 +83898,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + link-name -

    Name that identifies the link aggregate interface

    +

    Alphabetical concatenation of lag-interface names

    		 path @@ -84103,12 +83912,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + link-name -

    Name given to the interface

    +

    Alphabetical concatenation of lag-interface names

    		 path @@ -84119,12 +83989,132 @@ 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 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

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv4-address + link-name -

    IP address

    +

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    		 path @@ -84137,10 +84127,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + persona-model-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    the ASDC model id for this resource or service model.

    		 query @@ -84152,10 +84142,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + persona-model-version -

    ID of interface

    +

    the ASDC model version for this resource or service model.

    		 query @@ -84167,10 +84157,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + widget-model-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    		 query @@ -84182,10 +84172,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + widget-model-version -

    ID of interface

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    		 query @@ -84197,10 +84187,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -84212,10 +84202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + link-id -

    Name of the network

    +

    UUID of the logical-link, SDNC generates this.

    		 query @@ -84227,25 +84217,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 + circuit-id -

    Neutron network id of the interface that address belongs to

    +

    Circuit id

    		 query @@ -84257,10 +84232,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + purpose -

    Neutron id of subnet that address belongs to

    +

    Reason for this entity, role it is playing

    		 query @@ -84296,7 +84271,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /logical-link
    @@ -84324,17 +84299,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing logical-link
    +

    PUT /network/logical-links/logical-link/{link-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    create or update an existing logical-link

    @@ -84343,13 +84318,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

    +

    logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)

    - /l3-interface-ipv4-address-list + /logical-link
    @@ -84368,58 +84343,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + link-name -

    IP address

    +

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    		 path @@ -84461,23 +84388,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    update an existing logical-link
    +

    PATCH /network/logical-links/logical-link/{link-name}

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    update an existing logical-link

    application/json application/xml

    +
    +
    +

    logical-link object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /logical-link +
    +
    +
    @@ -84493,42 +84432,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + link-name -

    Name given to the interface

    +

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    		 path @@ -84539,12 +84446,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing logical-link
    +

    DELETE /network/logical-links/logical-link/{link-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing logical-link

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv4-address + link-name -

    IP address

    +

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    		 path @@ -84602,11 +84570,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

    Tags: Network
    @@ -84621,7 +84589,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)

    @@ -84646,58 +84614,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + link-name -

    IP address

    +

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    		 path @@ -84739,11 +84659,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

    Tags: Network
    @@ -84771,58 +84691,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + link-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

    +

    e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

    		 path @@ -84864,233 +84736,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns multicast-configurations
    +

    GET /network/multicast-configurations

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns multicast-configurations

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -85114,7 +84772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /l3-interface-ipv6-address-list + /multicast-configurations
    @@ -85142,36 +84800,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns multicast-configuration
    +

    GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns multicast-configuration

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -85186,58 +84827,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 + multicast-configuration-id -

    IP address

    +

    Unique id of multicast configuration.

    		 path @@ -85257,6 +84850,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /multicast-configuration +
    +
    +
    + +
    default @@ -85279,23 +84895,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 multicast-configuration
    +

    PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)

    +

    +
    +
    +
    +
    + /multicast-configuration +
    +
    +
    @@ -85311,58 +84939,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 + multicast-configuration-id -

    IP address

    +

    Unique id of multicast configuration.

    		 path @@ -85373,22 +84953,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -85420,17 +84984,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing multicast-configuration
    +

    PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing multicast-configuration

    @@ -85439,13 +85003,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

    +

    multicast-configuration object that needs to be created or updated.

    - /relationship + /multicast-configuration
    @@ -85464,58 +85028,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + multicast-configuration-id -

    IP address

    +

    Unique id of multicast configuration.

    		 path @@ -85557,17 +85073,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing multicast-configuration
    +

    DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing multicast-configuration

    @@ -85589,42 +85105,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + multicast-configuration-id -

    Name given to the interface

    +

    Unique id of multicast configuration.

    		 path @@ -85637,12 +85121,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -85682,11 +85166,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

    Tags: Network
    @@ -85701,7 +85185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)

    @@ -85726,42 +85210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + multicast-configuration-id -

    Name given to the interface

    +

    Unique id of multicast configuration.

    		 path @@ -85803,11 +85255,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

    Tags: Network
    @@ -85835,42 +85287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + multicast-configuration-id -

    Name given to the interface

    +

    Unique id of multicast configuration.

    		 path @@ -85912,172 +85332,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    returns network-policies
    +

    GET /network/network-policies

    Tags: Network
    -

    returns sriov-vfs

    +

    returns network-policies

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -86101,7 +85368,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /sriov-vfs + /network-policies
    @@ -86129,17 +85396,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    returns network-policy
    +

    GET /network/network-policies/network-policy/{network-policy-id}

    Tags: Network
    -

    returns sriov-vf

    +

    returns network-policy

    @@ -86156,58 +85423,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + network-policy-id -

    PCI ID used to identify the sriov-vf

    +

    UUID representing unique key to this instance

    		 path @@ -86220,145 +85439,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - 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 + network-policy-fqdn -

    Neutron network id of the interface

    +

    Contrail FQDN for the policy

    		 query @@ -86394,7 +85478,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /network-policy
    @@ -86422,17 +85506,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/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 network-policy
    +

    PUT /network/network-policies/network-policy/{network-policy-id}

    Tags: Network
    -

    create or update an existing sriov-vf

    +

    create or update an existing network-policy

    @@ -86441,13 +85525,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

    +

    network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)

    - /sriov-vf + /network-policy
    @@ -86466,58 +85550,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + network-policy-id -

    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

    +

    UUID representing unique key to this instance

    		 path @@ -86559,23 +85595,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing network-policy
    +

    PATCH /network/network-policies/network-policy/{network-policy-id}

    Tags: Network
    -

    delete an existing sriov-vf

    +

    update an existing network-policy

    application/json application/xml

    +
    +
    +

    network-policy object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /network-policy +
    +
    +
    @@ -86591,42 +85639,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + network-policy-id -

    Name given to the interface

    +

    UUID representing unique key to this instance

    		 path @@ -86637,12 +85653,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing network-policy
    +

    DELETE /network/network-policies/network-policy/{network-policy-id}

    + Tags: + Network +
    +
    +
    +

    delete an existing network-policy

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - + +
    - pci-id + network-policy-id -

    PCI ID used to identify the sriov-vf

    +

    UUID representing unique key to this instance

    		 path @@ -86700,11 +85777,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

    Tags: Network
    @@ -86719,7 +85796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)

    @@ -86744,42 +85821,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the link aggregate interface

    -     		path - string - - - -
    - interface-name + network-policy-id -

    Name given to the interface

    +

    UUID representing unique key to this instance

    		 path @@ -86790,12 +85835,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - -
    - pci-id + network-policy-id -

    PCI ID used to identify the sriov-vf

    +

    UUID representing unique key to this instance

    		 path @@ -86837,24 +85943,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +
    returns newvces
    +

    GET /network/newvces

    Tags: Network
    -

    delete an existing relationship

    +

    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

    -
    - -

    application/json application/xml -

    -
    @@ -86869,10 +86034,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + + + + + + + + @@ -86940,6 +86132,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /newvce +
    +
    +
    + +
    default @@ -86962,19 +86177,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    create or update an existing newvce
    +

    PUT /network/newvces/newvce/{vnf-id2}

    Tags: Network
    -

    returns vlans

    +

    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/v9/NetworkNewvcesNewvce.json)

    +

    +
    +
    +
    +
    + /newvce +
    +
    +
    +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -86885,50 +86050,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name that identifies the link aggregate interface

    +

    Name of VNF.

    		pathquery string -
    - interface-name + vnf-name2 -

    Name given to the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - pci-id + vnf-type -

    PCI ID used to identify the sriov-vf

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery + 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 -
    @@ -86989,10 +86221,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87003,12 +86235,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +
    +
    +
    +
    +
    + + + + + + + + + + + + +
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87019,12 +86324,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing newvce
    +

    DELETE /network/newvces/newvce/{vnf-id2}

    + Tags: + Network +
    +
    +
    +

    delete an existing newvce

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + vnf-id2 -

    Name given to the interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87037,10 +86403,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + resource-version -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    resource-version for concurrency

    		 query @@ -87048,14 +86414,87 @@ 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/newvces/newvce/{vnf-id2}/l-interfaces

    + Tags: + Network +
    +
    +
    +

    returns l-interfaces

    + +
    +
    + + + + + + + + + + + + + + + + + + - + - + - - - - - - - - - - - - - -
    - interface-id + vnf-id2 -

    ID of interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    +     		path + string + + + +
    + vnf-name + +

    Name of VNF.

    		 query @@ -87067,10 +86506,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + vnf-name2 -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Alternate name of VNF.

    		 query @@ -87082,10 +86521,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + vnf-type -

    ID of interface

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -87097,10 +86536,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -87112,10 +86551,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + heat-stack-id -

    Name of the network

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -87151,7 +86590,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /l-interfaces
    @@ -87179,17 +86618,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns l-interface
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    returns vlan

    +

    returns l-interface

    @@ -87206,10 +86645,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87225,7 +86664,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 given to the interface

    		 path @@ -87238,42 +86677,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name given to the interface

    +

    Name of VNF.

    		pathquery string -
    - vlan-interface + vnf-name2 -

    String that identifies the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - inv-status + vnf-type -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -87285,10 +86722,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + prov-status -

    ID of interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -87300,10 +86737,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + heat-stack-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -87358,36 +86795,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -87414,7 +86821,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /l-interface
    @@ -87442,17 +86849,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing l-interface
    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    create or update an existing vlan

    +

    create or update an existing l-interface

    @@ -87461,13 +86868,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)

    - /vlan + /l-interface
    @@ -87486,26 +86893,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87532,22 +86923,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    @@ -87579,23 +86954,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing l-interface
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    delete an existing vlan

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -87611,10 +86998,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87630,7 +87017,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 given to the interface

    		 path @@ -87641,12 +87028,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - interface-name + vnf-id2 -

    Name given to the interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87659,10 +87107,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 @@ -87720,11 +87168,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    @@ -87747,10 +87195,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -87766,7 +87214,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 given to the interface

    		 path @@ -87779,10 +87227,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -87795,42 +87243,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vnf-name -

    String that identifies the interface

    +

    Name of VNF.

    		pathquery string -
    - l3-interface-ipv4-address + vnf-name2 -

    IP address

    +

    Alternate name of VNF.

    		pathquery string -
    - inv-status + vnf-type -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -87842,10 +87288,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + prov-status -

    ID of interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -87857,10 +87303,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + heat-stack-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -87930,36 +87376,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    neutron-network-id @@ -88016,7 +87432,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -88044,11 +87460,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    @@ -88063,7 +87479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -88088,26 +87504,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -88134,22 +87534,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -88197,23 +87581,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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 +
    +
    +
    @@ -88229,10 +87625,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -88248,7 +87644,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 given to the interface

    		 path @@ -88261,10 +87657,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -88275,12 +87671,89 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /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 +

    +
    +
    + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - vlan-interface + vnf-id2 -

    String that identifies the interface

    +

    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 @@ -88354,11 +87827,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -88373,7 +87846,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -88398,26 +87871,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -88444,22 +87901,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -88507,11 +87948,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    @@ -88539,26 +87980,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -88585,22 +88010,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv4-address @@ -88648,11 +88057,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    @@ -88675,10 +88084,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -88694,7 +88103,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 given to the interface

    		 path @@ -88707,10 +88116,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name given to the interface

    +

    IP address

    		 path @@ -88723,42 +88132,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vnf-name -

    String that identifies the interface

    +

    Name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-name2 -

    IP address

    +

    Alternate name of VNF.

    		pathquery string -
    - inv-status + vnf-type -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -88770,10 +88177,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + prov-status -

    ID of interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -88785,10 +88192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + heat-stack-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -88858,36 +88265,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    neutron-network-id @@ -88944,7 +88321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -88972,11 +88349,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    @@ -88991,7 +88368,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -89016,26 +88393,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89062,22 +88423,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv6-address @@ -89125,23 +88470,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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
    +

    PATCH /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

    +

    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 +
    +
    +
    @@ -89157,10 +88514,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89176,7 +88533,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 given to the interface

    		 path @@ -89189,10 +88546,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name given to the interface

    +

    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 @@ -89205,10 +88639,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 @@ -89282,11 +88716,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +

    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
    @@ -89301,7 +88735,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    @@ -89326,26 +88760,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89372,22 +88790,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv6-address @@ -89435,11 +88837,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/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
    @@ -89467,26 +88869,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the link aggregate interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89513,22 +88899,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    l3-interface-ipv6-address @@ -89576,11 +88946,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -89595,7 +88965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)

    @@ -89620,10 +88990,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89639,7 +89009,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 given to the interface

    		 path @@ -89650,12 +89020,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + +
    - interface-name + vnf-id2 -

    Name given to the interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89668,10 +89099,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 @@ -89713,24 +89144,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    returns sriov-vfs
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    Tags: Network
    -

    delete an existing relationship

    +

    returns sriov-vfs

    -
    - -

    application/json application/xml -

    -
    @@ -89745,10 +89171,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -89816,6 +89330,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vfs +
    +
    +
    + +
    default @@ -89838,36 +89375,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    returns sriov-vf
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89764,7 +89190,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 given to the interface

    		 path @@ -89777,34 +89203,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name given to the interface

    +

    Name of VNF.

    		pathquery string -
    - vlan-interface + vnf-name2 -

    String that identifies the interface

    +

    Alternate name of VNF.

    		pathquery + 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 -
    @@ -89882,10 +89402,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89901,7 +89421,23 @@ 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 given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -89912,6 +89448,186 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vnf-name + +

    Name of VNF.

    +     		query + string + + +
    + vnf-name2 + +

    Alternate name of VNF.

    +     		query + string + + +
    + vnf-type + +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +     		query + string + + +
    + heat-stack-id + +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + 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 + + +
    @@ -89921,6 +89637,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -89943,23 +89682,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    create or update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -89975,10 +89726,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -89994,7 +89745,23 @@ 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 given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -90036,19 +89803,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces

    +
    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
    -

    returns p-interfaces

    +

    update an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    @@ -90063,10 +89847,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -90101,29 +89902,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interfaces -
    -
    -
    - -
    default @@ -90146,19 +89924,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    returns p-interface

    +

    delete an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90079,17 +89863,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + interface-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Name given to the interface

    		querypath + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path string +
    @@ -90173,10 +89956,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -90242,29 +90027,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interface -
    -
    -
    - -
    default @@ -90287,17 +90049,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing p-interface
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    create or update an existing p-interface

    +

    see node definition for valid relationships

    @@ -90306,13 +90068,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /p-interface + /relationship
    @@ -90331,10 +90093,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90192,7 +89975,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -90205,25 +89988,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + pci-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - prov-status + resource-version -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    resource-version for concurrency

    		 query @@ -90231,6 +90015,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90350,7 +90112,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    		 path @@ -90392,17 +90170,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing p-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    +
    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 p-interface

    +

    delete an existing relationship

    @@ -90424,10 +90202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90443,7 +90221,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -90456,12 +90234,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -90501,17 +90279,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interfaces
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    returns vlans
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns l-interfaces

    +

    returns vlans

    @@ -90528,10 +90306,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90547,7 +90325,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -90560,10 +90338,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vnf-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    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 @@ -90578,7 +90386,67 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    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 @@ -90614,7 +90482,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /vlans
    @@ -90642,17 +90510,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l-interface
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    returns vlan
    +

    GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    returns l-interface

    +

    returns vlan

    @@ -90669,10 +90537,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90688,7 +90556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -90701,10 +90569,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -90717,10 +90585,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vnf-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    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 @@ -90735,7 +90633,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    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 @@ -90790,6 +90703,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    @@ -90816,7 +90759,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /vlan
    @@ -90844,17 +90787,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing vlan

    @@ -90863,13 +90806,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l-interface object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

    - /l-interface + /vlan
    @@ -90888,10 +90831,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -90907,7 +90850,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -90920,10 +90863,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -90965,23 +90908,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l-interface
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    update an existing vlan
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    Tags: Network
    -

    delete an existing l-interface

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -90997,10 +90952,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91016,7 +90971,100 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    +     		path + string + + + +
    + 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 @@ -91043,6 +91091,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    resource-version @@ -91090,11 +91154,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    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
    @@ -91117,10 +91181,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91136,7 +91200,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -91149,10 +91213,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -91181,10 +91245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vnf-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    Name of VNF.

    		 query @@ -91196,10 +91260,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vnf-name2 -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Alternate name of VNF.

    		 query @@ -91211,10 +91275,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + vnf-type -

    ID of interface

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -91226,10 +91290,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -91241,10 +91305,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + heat-stack-id -

    Name of the network

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -91256,7 +91320,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + 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

    @@ -91325,7 +91464,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
    @@ -91353,11 +91492,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +

    PUT /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
    @@ -91372,7 +91511,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -91397,10 +91536,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91416,7 +91555,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    +     		path + string + + + +
    + 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 @@ -91443,6 +91703,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    l3-interface-ipv4-address @@ -91490,11 +91766,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/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 /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
    @@ -91522,10 +91798,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91541,7 +91817,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -91554,10 +91830,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -91631,11 +91907,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    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
    @@ -91650,7 +91926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    @@ -91675,10 +91951,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91694,7 +91970,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -91707,10 +91983,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -91768,11 +92044,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
    @@ -91800,10 +92076,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91819,7 +92095,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -91832,10 +92108,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -91893,11 +92169,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    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
    @@ -91920,10 +92196,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -91939,7 +92215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -91952,10 +92228,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -91984,10 +92260,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status + vnf-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    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 @@ -92002,7 +92308,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    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 @@ -92072,6 +92393,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    neutron-network-id @@ -92128,7 +92479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
    @@ -92156,11 +92507,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +

    PUT /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
    @@ -92175,7 +92526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -92200,26 +92551,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the physical interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -92248,119 +92583,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -92387,22 +92613,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -92434,17 +92644,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -92453,13 +92663,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -92478,10 +92688,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -92497,7 +92707,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -92510,10 +92720,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -92571,17 +92781,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv6-address-list
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -92603,10 +92813,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -92622,7 +92832,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -92635,10 +92845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -92665,6 +92875,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -92696,11 +92922,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -92715,7 +92941,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -92740,10 +92966,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -92759,7 +92985,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -92772,10 +92998,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -92817,11 +93059,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    Tags: Network
    @@ -92849,10 +93091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -92868,7 +93110,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -92881,10 +93123,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -92926,19 +93184,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vfs
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    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
    -

    returns sriov-vfs

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -92953,10 +93228,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - pnf-name + vnf-id2 -

    unique name of Physical Network Function.

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -92972,7 +93247,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name that identifies the physical interface

    +

    Name given to the interface

    		 path @@ -92985,10 +93260,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vlan-interface -

    Name given to the interface

    +

    String that identifies the interface

    		 path @@ -92999,79 +93274,113 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + @@ -93083,29 +93392,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vfs -
    -
    -
    - -
    default @@ -93128,19 +93414,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns sriov-vf
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    see node definition for valid relationships
    +

    PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    Tags: Network
    -

    returns sriov-vf

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - 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 + vnf-id2 -

    ID of interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name given to the interface

    		querypath string +
    - network-name + vlan-interface -

    Name of the network

    +

    String that identifies the interface

    		querypath string +
    @@ -93155,26 +93458,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name + vnf-id2 -

    Name that identifies the physical interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -93185,12 +93472,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - interface-name + vnf-id2 -

    Name given to the interface

    +

    Unique id of VNF, can't use same attribute name right now until we promote this new object

    		 path @@ -93201,12 +93549,132 @@ 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 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

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pci-id + link-name -

    PCI ID used to identify the sriov-vf

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -93219,130 +93687,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - inv-status - -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    -     		query - string - - -
    - 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 + circuit-id -

    Neutron network id of the interface

    +

    Circuit it

    		 query @@ -93378,7 +93726,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /physical-link
    @@ -93406,17 +93754,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/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 physical-link
    +

    PUT /network/physical-links/physical-link/{link-name}

    Tags: Network
    -

    create or update an existing sriov-vf

    +

    create or update an existing physical-link

    @@ -93425,13 +93773,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

    +

    physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)

    - /sriov-vf + /physical-link
    @@ -93450,58 +93798,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + link-name -

    PCI ID used to identify the sriov-vf

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -93543,23 +93843,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing sriov-vf
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing physical-link
    +

    PATCH /network/physical-links/physical-link/{link-name}

    Tags: Network
    -

    delete an existing sriov-vf

    +

    update an existing physical-link

    application/json application/xml

    +
    +
    +

    physical-link object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /physical-link +
    +
    +
    @@ -93575,42 +93887,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
    - pnf-name - -

    unique name of Physical Network Function.

    -     		path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + link-name -

    Name given to the interface

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -93621,12 +93901,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing physical-link
    +

    DELETE /network/physical-links/physical-link/{link-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing physical-link

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - pci-id + link-name -

    PCI ID used to identify the sriov-vf

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -93684,11 +94025,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

    Tags: Network
    @@ -93703,7 +94044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)

    @@ -93728,58 +94069,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + link-name -

    PCI ID used to identify the sriov-vf

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -93821,11 +94114,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

    Tags: Network
    @@ -93853,58 +94146,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + link-name -

    PCI ID used to identify the sriov-vf

    +

    e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

    		 path @@ -93946,157 +94191,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    returns pnfs
    +

    GET /network/pnfs

    Tags: Network
    -

    returns vlans

    +

    returns pnfs

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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 @@ -94120,7 +94227,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /vlans + /pnfs
    @@ -94148,17 +94255,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vlan
    -

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns pnf
    +

    GET /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    returns vlan

    +

    returns pnf

    @@ -94189,54 +94296,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    inv-status @@ -94252,96 +94311,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - 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 - - -
    @@ -94368,7 +94337,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /pnf
    @@ -94396,17 +94365,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    create or update an existing pnf
    +

    PUT /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    create or update an existing vlan

    +

    create or update an existing pnf

    @@ -94415,13 +94384,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)

    - /vlan + /pnf
    @@ -94454,54 +94423,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    @@ -94533,30 +94454,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing pnf
    +

    PATCH /network/pnfs/pnf/{pnf-name}

    Tags: Network
    -

    delete an existing vlan

    +

    update an existing pnf

    application/json application/xml

    -
    -
    - - - - - +
    +
    +

    pnf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /pnf +
    +
    +
    + +
    +
    + + + + @@ -94579,12 +94512,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing pnf
    +

    DELETE /network/pnfs/pnf/{pnf-name}

    + Tags: + Network +
    +
    +
    +

    delete an existing pnf

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + + +
    - interface-name + pnf-name -

    Name that identifies the physical interface

    +

    unique name of Physical Network Function.

    		 path @@ -94597,12 +94591,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-version -

    Name given to the interface

    +

    resource-version for concurrency

    		pathquery string @@ -94611,12 +94605,68 @@ 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 lag-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

    + Tags: + Network +
    +
    +
    +

    returns lag-interfaces

    + +
    +
    + + + + + + + + + + + @@ -94652,6 +94701,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /lag-interfaces +
    +
    +
    + +
    default @@ -94674,17 +94746,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-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 lag-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    returns lag-interface

    @@ -94720,7 +94792,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    - + + + + + + + + + + + + + +
    - vlan-interface + pnf-name -

    String that identifies the interface

    +

    unique name of Physical Network Function.

    		 path @@ -94629,10 +94679,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + inv-status -

    resource-version for concurrency

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -94640,7 +94690,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -94733,26 +94805,151 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + inv-status -

    Name given to the interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - vlan-interface + interface-id -

    String that identifies the interface

    +

    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/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + +
    + pnf-name + +

    unique name of Physical Network Function.

    		 path @@ -94765,10 +94962,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 that identifies the link aggregate interface

    		 path @@ -94779,72 +94976,210 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing 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 +
    +
    +
    +
    +
    + + + + + + + + + + + - + - + + +
    - inv-status + pnf-name -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    unique name of Physical Network Function.

    		querypath string +
    - prov-status + interface-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Name that identifies the link aggregate interface

    		querypath 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 +

    +
    +
    + + + + + + + + + + + - + - + + +
    - interface-id + pnf-name -

    ID of interface

    +

    unique name of Physical Network Function.

    		querypath string +
    - macaddr + interface-name -

    MAC address for the interface

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - network-name + resource-version -

    Name of the network

    +

    resource-version for concurrency

    		 query @@ -94852,48 +95187,107 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns l-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    + Tags: + Network +
    +
    +
    +

    returns l-interfaces

    + +
    +
    + + + + + + + + + + + - + - + - - - - - - - - - - - - - -
    - vlan-id-inner + pnf-name -

    Inner VLAN tag

    +

    unique name of Physical Network Function.

    		querypath - integer + string +
    - vpn-id + interface-name -

    This indicates the customers VPN ID associated with this vlan

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - vlan-id-inner + inv-status -

    Inner VLAN tag

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query - integer + string @@ -94901,10 +95295,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + interface-id -

    Neutron network id of the interface that address belongs to

    +

    ID of interface

    		 query @@ -94916,10 +95310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + interface-role -

    Neutron id of subnet that address belongs to

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -94955,7 +95349,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /l-interfaces
    @@ -94983,36 +95377,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-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 l-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns l-interface

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -95046,7 +95423,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -95114,6 +95549,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interface +
    +
    +
    + +
    default @@ -95136,23 +95594,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -95075,34 +95452,92 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + inv-status -

    String that identifies the interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - l3-interface-ipv4-address + interface-id -

    IP address

    +

    ID of interface

    		pathquery + 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 -
    @@ -95187,7 +95657,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -95214,54 +95684,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -95293,17 +95715,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l-interface

    @@ -95312,13 +95734,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

    +

    l-interface object that needs to be created or updated.

    - /relationship + /l-interface
    @@ -95356,7 +95778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -95383,38 +95805,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address - -

    IP address

    -     		path - string - - - -
    @@ -95446,17 +95836,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l-interface

    @@ -95497,7 +95887,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -95526,28 +95916,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -95587,17 +95961,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/pnfs/pnf/{pnf-name}/p-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-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-ipv6-address-list

    +

    returns l3-interface-ipv4-address-list

    @@ -95633,7 +96007,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -95662,10 +96036,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -95678,26 +96052,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + inv-status -

    IP address

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - inv-status + interface-id -

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +

    ID of interface

    		 query @@ -95709,10 +96082,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-role -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -95782,36 +96155,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    neutron-network-id @@ -95868,7 +96211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -95896,17 +96239,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv6-address-list
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    create or update an existing l3-interface-ipv4-address-list
    +

    PUT /network/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-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -95915,13 +96258,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -95959,7 +96302,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -95988,23 +96331,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -96049,23 +96376,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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-ipv4-address-list
    +

    PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -96100,7 +96439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -96129,23 +96468,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -96159,22 +96482,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -96206,35 +96513,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-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 l3-interface-ipv4-address-list
    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -96269,7 +96564,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -96298,10 +96593,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -96314,12 +96609,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -96359,23 +96654,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-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
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -96410,7 +96717,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -96439,23 +96746,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + l3-interface-ipv4-address

    IP address

    @@ -96500,35 +96791,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -96563,7 +96842,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -96592,10 +96871,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv4-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -96637,24 +96916,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -96688,7 +96962,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    -

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -96717,10 +96991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + l3-interface-ipv6-address -

    String that identifies the interface

    +

    IP address

    		 path @@ -96731,6 +97005,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + 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 + + +
    @@ -96740,6 +97149,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -96762,17 +97194,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -96781,13 +97213,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /relationship + /l3-interface-ipv6-address-list
    @@ -96825,7 +97257,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
    		-

    Name that identifies the physical interface

    +

    Name that identifies the link aggregate interface

    		 path @@ -96836,73 +97268,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + interface-name -

    unique name of Physical Network Function.

    +

    Name given to the interface

    		 path @@ -96915,10 +97286,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv6-address -

    Name that identifies the physical interface

    +

    IP address

    		 path @@ -96960,17 +97331,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -96979,13 +97350,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -97018,6 +97389,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    @@ -97049,17 +97468,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -97095,132 +97514,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    - -
    -
    - - - - - - - - - - - + + + + + + + + + + + + + + @@ -97255,29 +97587,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /route-table-reference -
    -
    -
    - -
    default @@ -97300,17 +97609,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing route-table-reference
    -

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    see node definition for valid relationships
    +

    PUT /network/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
    -

    create or update an existing route-table-reference

    +

    see node definition for valid relationships

    @@ -97319,13 +97628,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    route-table-reference object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /route-table-reference + /relationship
    @@ -97344,10 +97653,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - route-table-reference-id + interface-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    Name that identifies the link aggregate interface

    		 path @@ -97233,10 +97532,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-fqdn + interface-name -

    FQDN entry in the route table.

    +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -97244,6 +97575,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -97389,17 +97746,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing route-table-reference
    -

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

    +
    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 route-table-reference

    +

    delete an existing relationship

    @@ -97421,10 +97778,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    unique name of Physical Network Function.

    		 path @@ -97437,12 +97794,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -97482,11 +97871,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -97501,7 +97890,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

    @@ -97526,10 +97915,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -97571,11 +97992,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -97603,10 +98024,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - route-table-reference-id + pnf-name -

    Route Table Reference id, UUID assigned to this instance.

    +

    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 @@ -97648,81 +98101,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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}

    +
    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 site-pair-set

    +

    returns sriov-vfs

    @@ -97739,10 +98128,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    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 @@ -97753,6 +98174,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    @@ -97779,7 +98290,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /site-pair-set + /sriov-vfs
    @@ -97807,36 +98318,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing site-pair-set
    -

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    +
    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
    -

    create or update an existing site-pair-set

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    site-pair-set object that needs to be created or updated

    -

    -
    -
    -
    -
    - /site-pair-set -
    -
    -
    -
    @@ -97851,10 +98345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -97865,73 +98359,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + interface-name -

    Unique id of site pair set.

    +

    Name that identifies the link aggregate interface

    		 path @@ -97944,12 +98377,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -97958,85 +98391,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - site-pair-set-id + pci-id -

    Unique id of site pair set.

    +

    PCI ID used to identify the sriov-vf

    		 path @@ -98047,153 +98407,154 @@ 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/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 + inv-status -

    Unique id of site pair set.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery 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

    - -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -98222,7 +98583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /routing-instances + /sriov-vf
    @@ -98250,19 +98611,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns routing-instance
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

    +
    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
    -

    returns routing-instance

    +

    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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    - site-pair-set-id + interface-id -

    Unique id of site pair set.

    +

    ID of interface

    		pathquery + 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 -
    @@ -98277,10 +98655,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98293,10 +98671,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    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 @@ -98316,29 +98726,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /routing-instance -
    -
    -
    - -
    default @@ -98361,17 +98748,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    create or update an existing routing-instance

    +

    update an existing sriov-vf

    @@ -98380,13 +98767,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    routing-instance object that needs to be created or updated

    +

    sriov-vf object that needs to be created or updated.

    - /routing-instance + /sriov-vf
    @@ -98405,10 +98792,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98421,10 +98808,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    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 @@ -98466,17 +98885,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete 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 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 routing-instance

    +

    delete an existing sriov-vf

    @@ -98498,10 +98917,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98514,10 +98933,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    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 @@ -98575,11 +99026,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    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

    +

    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
    @@ -98594,7 +99045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    @@ -98619,10 +99070,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98635,10 +99086,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    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 @@ -98680,11 +99163,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    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

    +

    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
    @@ -98712,10 +99195,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98728,10 +99211,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    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 @@ -98773,17 +99288,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns site-pairs
    -

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

    +
    returns vlans
    +

    GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns site-pairs

    +

    returns vlans

    @@ -98800,10 +99315,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98816,10 +99331,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -98830,6 +99361,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    @@ -98856,7 +99477,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /site-pairs + /vlans
    @@ -98884,17 +99505,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 site-pair

    +

    returns vlan

    @@ -98911,10 +99532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -98927,10 +99548,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -98943,10 +99564,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -98957,6 +99594,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    @@ -98983,7 +99740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /site-pair + /vlan
    @@ -99011,17 +99768,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 site-pair

    +

    create or update an existing vlan

    @@ -99030,13 +99787,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    site-pair object that needs to be created or updated

    +

    vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /site-pair + /vlan
    @@ -99055,10 +99812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99071,10 +99828,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99087,10 +99844,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -99132,23 +99905,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    delete an existing site-pair

    +

    update an existing vlan

    application/json application/xml

    +
    +
    +

    vlan object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -99164,10 +99949,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99180,10 +99965,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99196,10 +99981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -99212,12 +99997,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath string @@ -99257,22 +100042,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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
    -

    returns classes-of-service

    +

    delete an existing vlan

    -
    - - +
    + +

    application/json application/xml +

    +
    +
    +
    + @@ -99284,10 +100074,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99300,10 +100090,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99316,10 +100106,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -99330,6 +100136,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -99339,29 +100161,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /classes-of-service -
    -
    -
    - -
    default @@ -99384,17 +100183,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 class-of-service

    +

    returns l3-interface-ipv4-address-list

    @@ -99411,10 +100210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99427,10 +100226,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99443,10 +100242,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -99459,10 +100258,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + vlan-interface -

    unique identifier of probe

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -99473,6 +100288,171 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + 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 + + +
    @@ -99499,7 +100479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /class-of-service + /l3-interface-ipv4-address-list
    @@ -99527,17 +100507,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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 class-of-service

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -99546,13 +100526,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    class-of-service object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /class-of-service + /l3-interface-ipv4-address-list
    @@ -99571,10 +100551,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99587,10 +100567,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99603,10 +100583,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -99619,10 +100599,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + vlan-interface -

    unique identifier of probe

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -99664,23 +100660,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    delete an existing class-of-service

    +

    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 +
    +
    +
    @@ -99696,10 +100704,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99712,10 +100720,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99728,10 +100736,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -99744,10 +100752,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + vlan-interface -

    unique identifier of probe

    +

    String that identifies the interface

    		 path @@ -99760,12 +100768,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -99805,35 +100813,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -99849,10 +100845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99865,10 +100861,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -99881,10 +100877,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -99897,10 +100893,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + vlan-interface -

    unique identifier of probe

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -99911,6 +100923,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -99942,23 +100970,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -99974,10 +101014,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -99990,10 +101030,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -100006,10 +101046,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -100022,10 +101062,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cos + vlan-interface -

    unique identifier of probe

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -100067,35 +101123,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -100111,10 +101155,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -100127,10 +101171,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -100143,10 +101187,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    		 path @@ -100188,24 +101264,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -100220,10 +101291,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - site-pair-set-id + pnf-name -

    Unique id of site pair set.

    +

    unique name of Physical Network Function.

    		 path @@ -100236,10 +101307,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - routing-instance-id + interface-name -

    Unique id of routing instance

    +

    Name that identifies the link aggregate interface

    		 path @@ -100252,10 +101323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - site-pair-id + interface-name -

    unique identifier of probe

    +

    Name given to the interface

    		 path @@ -100266,132 +101337,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + vlan-interface -

    Unique id of VNF. This is unique across the graph.

    +

    String that identifies the interface

    		 path @@ -100404,10 +101355,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name + l3-interface-ipv6-address -

    Name of VNF.

    +

    IP address

    +     		path + string + + + +
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -100419,10 +101386,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 @@ -100434,10 +101401,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + interface-role -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -100449,10 +101416,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + interface-id -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    ID of interface

    		 query @@ -100464,10 +101431,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + macaddr -

    Regional way of organizing pservers, source of truth should define values

    +

    MAC address for the interface

    		 query @@ -100479,10 +101446,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + network-name -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Name of the network

    		 query @@ -100494,10 +101461,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + vlan-id-inner -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    		 query @@ -100509,10 +101491,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpe-id + vlan-id-inner -

    Unique ID of VPE connected to this VCE.

    +

    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 @@ -100548,7 +101560,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vce + /l3-interface-ipv6-address-list
    @@ -100576,17 +101588,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vce
    -

    PUT /network/vces/vce/{vnf-id}

    +
    create or update an existing l3-interface-ipv6-address-list
    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    Tags: Network
    -

    create or update an existing vce

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -100595,13 +101607,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vce object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    - /vce + /l3-interface-ipv6-address-list
    @@ -100620,10 +101632,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    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 @@ -100665,23 +101741,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vce
    -

    DELETE /network/vces/vce/{vnf-id}

    +
    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
    -

    delete an existing vce

    +

    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 +
    +
    +
    @@ -100697,10 +101785,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -100713,12 +101801,60 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -100758,19 +101894,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlements
    -

    GET /network/vces/vce/{vnf-id}/entitlements

    +
    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
    -

    returns entitlements

    +

    delete an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -100785,10 +101926,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + - + - + - - - - - - - - - - - - - - @@ -100928,29 +102029,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /entitlements -
    -
    -
    - -
    default @@ -100973,19 +102051,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns entitlement
    -

    GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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
    -

    returns entitlement

    +

    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/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -100801,115 +101942,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + interface-name -

    Alternate name of VNF.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name given to the interface

    		querypath string +
    - service-id + vlan-interface -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    String that identifies the interface

    		querypath string +
    - regional-resource-zone + l3-interface-ipv6-address -

    Regional way of organizing pservers, source of truth should define values

    +

    IP address

    		querypath string +
    - prov-status + resource-version -

    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.

    +

    resource-version for concurrency

    		 query @@ -100917,6 +102017,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -101000,10 +102095,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + + +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -101016,10 +102111,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -101032,10 +102127,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    		 path @@ -101048,122 +102143,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 + vlan-interface -

    Alternate name of VNF.

    +

    String that identifies the interface

    		querypath string +
    - vnf-type + l3-interface-ipv6-address -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    IP address

    		querypath string +
    +
    + +
    +

    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 +

    +
    +
    + + + + + + + + + + + - + - + - + - + - + @@ -101175,29 +102323,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /entitlement -
    -
    -
    - -
    default @@ -101220,17 +102345,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing entitlement
    -

    PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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
    -

    create or update an existing entitlement

    +

    see node definition for valid relationships

    @@ -101239,13 +102364,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    entitlement object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /entitlement + /relationship
    @@ -101264,10 +102389,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - service-id + pnf-name -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    unique name of Physical Network Function.

    		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 +
    - 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

    +

    String that identifies the interface

    		querypath string +
    - vpe-id + l3-interface-ipv6-address -

    Unique ID of VPE connected to this VCE.

    +

    IP address

    		querypath string +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -101280,10 +102405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -101296,10 +102421,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -101341,17 +102482,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing entitlement
    -

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    +
    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 entitlement

    +

    delete an existing relationship

    @@ -101373,10 +102514,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -101389,10 +102530,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Name that identifies the link aggregate interface

    		 path @@ -101405,10 +102546,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name given to the interface

    		 path @@ -101421,12 +102562,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath string @@ -101466,11 +102607,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +

    PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -101485,7 +102626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)

    @@ -101510,26 +102651,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + pnf-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    unique name of Physical Network Function.

    		 path @@ -101542,10 +102667,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name that identifies the link aggregate interface

    		 path @@ -101587,11 +102712,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +

    DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    @@ -101619,26 +102744,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + pnf-name -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    unique name of Physical Network Function.

    		 path @@ -101651,10 +102760,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of an entitlement resource.

    +

    Name that identifies the link aggregate interface

    		 path @@ -101696,17 +102805,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns licenses
    -

    GET /network/vces/vce/{vnf-id}/licenses

    +
    returns p-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces

    Tags: Network
    -

    returns licenses

    +

    returns p-interfaces

    @@ -101723,10 +102832,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -101739,115 +102848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not 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 + inv-status -

    Unique ID of VPE connected to this VCE.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -101883,7 +102887,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /licenses + /p-interfaces
    @@ -101911,17 +102915,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns license
    -

    GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    returns p-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    returns license

    +

    returns p-interface

    @@ -101938,26 +102942,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + pnf-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    unique name of Physical Network Function.

    		 path @@ -101970,10 +102958,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name that identifies the physical interface

    		 path @@ -101986,70 +102974,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - service-id - -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    -     		query - string - - -
    - regional-resource-zone + inv-status -

    Regional way of organizing pservers, source of truth should define values

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -102074,36 +103002,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id - -

    Heat stack id corresponding to this instance, managed by MSO

    -     		query - string - - -
    - vpe-id - -

    Unique ID of VPE connected to this VCE.

    -     		query - string - - -
    @@ -102130,7 +103028,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /license + /p-interface
    @@ -102158,17 +103056,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing license
    -

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    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 license

    +

    create or update an existing p-interface

    @@ -102177,13 +103075,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    license object that needs to be created or updated

    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)

    - /license + /p-interface
    @@ -102202,26 +103100,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + pnf-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    unique name of Physical Network Function.

    		 path @@ -102234,10 +103116,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name that identifies the physical interface

    		 path @@ -102279,23 +103161,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing license
    -

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    +
    update an existing p-interface
    +

    PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    delete an existing license

    +

    update an existing p-interface

    application/json application/xml

    +
    +
    +

    p-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /p-interface +
    +
    +
    @@ -102311,26 +103205,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - vnf-id - -

    Unique id of VNF. This is unique across the graph.

    -     		path - string - - - -
    - group-uuid + pnf-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    unique name of Physical Network Function.

    		 path @@ -102343,10 +103221,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + interface-name -

    Unique ID of a license resource.

    +

    Name that identifies the physical interface

    		 path @@ -102357,22 +103235,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -102404,35 +103266,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    delete an existing p-interface
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing p-interface

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -102448,10 +103298,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -102464,10 +103314,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -102480,12 +103330,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + resource-version -

    Unique ID of a license resource.

    +

    resource-version for concurrency

    		pathquery string @@ -102525,24 +103375,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    +
    returns l-interfaces
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns l-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -102557,10 +103402,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -102612,6 +103471,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l-interfaces +
    +
    +
    + +
    default @@ -102634,17 +103516,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns port-groups
    -

    GET /network/vces/vce/{vnf-id}/port-groups

    +
    returns l-interface
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: Network
    -

    returns port-groups

    +

    returns l-interface

    @@ -102661,10 +103543,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - + - +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -102573,10 +103418,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-uuid + interface-name -

    Unique ID for the license group the resource belongs to, should be uuid.

    +

    Name that identifies the physical interface

    		 path @@ -102589,18 +103434,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-uuid + inv-status -

    Unique ID of a license resource.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query string -
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -102677,55 +103559,42 @@ 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 physical interface

    		querypath string +
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name given to the interface

    		querypath string +
    - service-id + inv-status -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -102737,10 +103606,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + prov-status -

    Regional way of organizing pservers, source of truth should define values

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -102752,10 +103621,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    ID of interface

    		 query @@ -102767,10 +103636,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + macaddr -

    Heat stack id corresponding to this instance, managed by MSO

    +

    MAC address for the interface

    		 query @@ -102782,10 +103651,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpe-id + network-name -

    Unique ID of VPE connected to this VCE.

    +

    Name of the network

    		 query @@ -102821,7 +103690,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /port-groups + /l-interface
    @@ -102849,19 +103718,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns port-group
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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
    -

    returns port-group

    +

    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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    +
    @@ -102876,10 +103762,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -103080,29 +103817,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /port-group -
    -
    -
    - -
    default @@ -103125,17 +103839,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing port-group
    -

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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
    -

    create or update an existing port-group

    +

    update an existing l-interface

    @@ -103144,13 +103858,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    port-group object that needs to be created or updated

    +

    l-interface object that needs to be created or updated.

    - /port-group + /l-interface
    @@ -103169,10 +103883,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + - - - - - - - - + - +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -102892,10 +103778,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -102908,167 +103794,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-name - -

    Name of VNF.

    -     		query - string - - -
    - vnf-name2 - -

    Alternate name of VNF.

    -     		query - string - - -
    - vnf-type - -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    -     		query - string - - -
    - 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 + interface-name -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Name given to the interface

    		querypath string +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -103185,10 +103899,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -103230,17 +103960,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing port-group
    -

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    +
    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 port-group

    +

    delete an existing l-interface

    @@ -103262,10 +103992,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -103278,10 +104008,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -103339,17 +104085,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns cvlan-tags
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

    +
    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 cvlan-tags

    +

    returns l3-interface-ipv4-address-list

    @@ -103366,10 +104112,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -103382,10 +104128,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -103398,55 +104144,42 @@ 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 given to the interface

    		querypath string +
    - vnf-type + l3-interface-ipv4-address -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    IP address

    		querypath string +
    - service-id + inv-status -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -103458,10 +104191,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - regional-resource-zone + prov-status -

    Regional way of organizing pservers, source of truth should define values

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -103473,10 +104206,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    ID of interface

    		 query @@ -103488,10 +104221,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + macaddr -

    Heat stack id corresponding to this instance, managed by MSO

    +

    MAC address for the interface

    		 query @@ -103503,10 +104236,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpe-id + network-name -

    Unique ID of VPE connected to this VCE.

    +

    Name of the network

    		 query @@ -103518,14 +104251,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - port-group-id + vlan-id-inner -

    Unique ID for port group in vmware

    +

    Inner VLAN tag

    		 query - string + integer @@ -103533,10 +104266,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - switch-name + neutron-network-id -

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    +

    Neutron network id of the interface that address belongs to

    		 query @@ -103548,10 +104281,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - heat-stack-id + neutron-subnet-id -

    Heat stack id corresponding to this instance, managed by MSO

    +

    Neutron id of subnet that address belongs to

    		 query @@ -103587,7 +104320,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /cvlan-tags + /l3-interface-ipv4-address-list
    @@ -103615,19 +104348,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns cvlan-tag-entry
    -

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

    +
    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
    -

    returns cvlan-tag-entry

    +

    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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    +
    @@ -103642,10 +104392,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -103862,29 +104463,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /cvlan-tag-entry -
    -
    -
    - -
    default @@ -103907,17 +104485,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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
    -

    create or update an existing cvlan-tag-entry

    +

    update an existing l3-interface-ipv4-address-list

    @@ -103926,13 +104504,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    cvlan-tag-entry object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    - /cvlan-tag-entry + /l3-interface-ipv4-address-list
    @@ -103951,10 +104529,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -103658,10 +104408,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -103674,183 +104424,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + interface-name -

    See mis-na-virtualization-platform.yang

    +

    Name given to the interface

    		 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 + l3-interface-ipv4-address -

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    +

    IP address

    		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

    -     		querypath string +
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -103967,10 +104545,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -103983,14 +104561,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + interface-name -

    See mis-na-virtualization-platform.yang

    +

    Name given to the interface

    		 path - integer + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string @@ -104028,17 +104622,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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 cvlan-tag-entry

    +

    delete an existing l3-interface-ipv4-address-list

    @@ -104060,10 +104654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -104076,10 +104670,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -104092,14 +104686,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + interface-name -

    See mis-na-virtualization-platform.yang

    +

    Name given to the interface

    		 path - integer + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string @@ -104153,11 +104763,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    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

    +

    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
    @@ -104172,7 +104782,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    @@ -104197,10 +104807,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -104213,10 +104823,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -104229,14 +104839,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + interface-name -

    See mis-na-virtualization-platform.yang

    +

    Name given to the interface

    		 path - integer + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string @@ -104274,11 +104900,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    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

    +

    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
    @@ -104306,10 +104932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -104322,10 +104948,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -104338,14 +104964,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag + interface-name -

    See mis-na-virtualization-platform.yang

    +

    Name given to the interface

    		 path - integer + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path + string @@ -104383,129 +105025,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    -
    -
    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

    -

    -
    -
    -
    -
    - /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

    +
    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
    -

    delete an existing relationship

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -104520,10 +105052,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - vnf-id + pnf-name -

    Unique id of VNF. This is unique across the graph.

    +

    unique name of Physical Network Function.

    		 path @@ -104536,10 +105068,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + interface-name -

    Unique ID of the interface

    +

    Name that identifies the physical interface

    		 path @@ -104550,85 +105082,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - -
    - vnf-id + interface-name -

    Unique id of VNF. This is unique across the graph.

    +

    Name given to the interface

    		 path @@ -104639,73 +105098,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

    - Tags: - Network -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - -
    - vnf-id + l3-interface-ipv6-address -

    Unique id of VNF. This is unique across the graph.

    +

    IP address

    		 path @@ -104716,148 +105114,27 @@ 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 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 + inv-status -

    Unique ID of vnfc.

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		pathquery string -
    - vnfc-function-code + prov-status -

    function code

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -104869,10 +105146,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-type + interface-id -

    type

    +

    ID of interface

    		 query @@ -104884,10 +105161,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + macaddr -

    prov status of this vnfc

    +

    MAC address for the interface

    		 query @@ -104899,10 +105176,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - ipaddress-v4-oam-vip + network-name -

    Oam V4 vip address of this vnfc

    +

    Name of the network

    		 query @@ -104914,13 +105191,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - in-maint + vlan-id-inner +

    Inner VLAN tag

    		 query - boolean + integer @@ -104928,13 +105206,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - is-closed-loop-disabled + neutron-network-id +

    Neutron network id of the interface that address belongs to

    		 query - boolean + string @@ -104942,10 +105221,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - group-notation + neutron-subnet-id -

    Group notation of VNFC

    +

    Neutron id of subnet that address belongs to

    		 query @@ -104981,7 +105260,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnfc + /l3-interface-ipv6-address-list
    @@ -105009,17 +105288,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vnfc
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}

    +
    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 vnfc

    +

    create or update an existing l3-interface-ipv6-address-list

    @@ -105028,13 +105307,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vnfc object that needs to be created or updated

    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    - /vnfc + /l3-interface-ipv6-address-list
    @@ -105053,10 +105332,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + pnf-name -

    Unique ID of vnfc.

    +

    unique name of Physical Network Function.

    		 path @@ -105067,73 +105346,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing vnfc
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}

    - Tags: - Network -
    -
    -
    -

    delete an existing vnfc

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - vnfc-name + interface-name -

    Unique ID of vnfc.

    +

    Name that identifies the physical interface

    		 path @@ -105146,12 +105364,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string @@ -105191,17 +105425,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -105210,13 +105444,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -105235,10 +105469,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + pnf-name -

    Unique ID of vnfc.

    +

    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 @@ -105280,17 +105562,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -105312,10 +105594,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnfc-name + pnf-name -

    Unique ID of vnfc.

    +

    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 @@ -105326,6 +105656,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -105357,83 +105703,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vpls-pes
    -

    GET /network/vpls-pes

    +
    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
    -

    returns vpls-pes

    +

    see node definition for valid relationships

    - -
    -

    application/json application/xml -

    - -
    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vpls-pes -
    -
    -
    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns vpls-pe
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}

    - Tags: - Network -
    -
    -
    -

    returns vpls-pe

    - -
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -105448,9 +105747,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -105485,29 +105818,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vpls-pe -
    -
    -
    - -
    default @@ -105530,35 +105840,23 @@ 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}

    +
    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
    -

    create or update an existing vpls-pe

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    vpls-pe object that needs to be created or updated

    -

    -
    -
    -
    -
    - /vpls-pe -
    -
    -
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -105463,17 +105763,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    +     		path string +
    @@ -105574,9 +105872,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    - equipment-name + 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 @@ -105618,23 +105965,35 @@ 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}

    +
    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
    -

    delete an existing vpls-pe

    +

    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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -105650,9 +106009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -105665,12 +106025,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path string @@ -105710,19 +106086,24 @@ 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

    +
    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
    -

    returns lag-interfaces

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -105737,9 +106118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -105774,29 +106173,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /lag-interfaces -
    -
    -
    - -
    default @@ -105819,17 +106195,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 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 lag-interface

    +

    returns sriov-vfs

    @@ -105846,9 +106222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -105752,17 +106134,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name that identifies the physical interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path string +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -105864,7 +106241,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 @@ -105877,25 +106254,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + interface-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name given to the interface

    		querypath string +
    - interface-id + inv-status -

    ID of interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -105907,10 +106285,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    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 @@ -105946,7 +106369,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /lag-interface + /sriov-vfs
    @@ -105974,36 +106397,19 @@ 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}

    +
    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
    -

    create or update an existing lag-interface

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    lag-interface object that needs to be created or updated

    -

    -
    -
    -
    -
    - /lag-interface -
    -
    -
    -
    @@ -106018,9 +106424,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106036,7 +106443,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 @@ -106047,6 +106454,173 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    + 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 + + +
    @@ -106056,6 +106630,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -106078,23 +106675,35 @@ 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}

    +
    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
    -

    delete an existing lag-interface

    +

    create or update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -106110,9 +106719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106128,7 +106738,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 @@ -106141,12 +106751,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath + string + + + +
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path string @@ -106186,19 +106812,36 @@ 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

    +
    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
    -

    returns l-interfaces

    +

    update an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    +
    @@ -106213,9 +106856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -106296,29 +106927,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interfaces -
    -
    -
    - -
    default @@ -106341,19 +106949,24 @@ 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}

    +
    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
    -

    returns l-interface

    +

    delete an existing sriov-vf

    +
    + +

    application/json application/xml +

    +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106231,7 +106875,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 @@ -106244,47 +106888,34 @@ 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 + interface-name -

    ID of interface

    +

    Name given to the interface

    		querypath string +
    - interface-role + pci-id -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    @@ -106368,9 +106981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -106512,29 +107068,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l-interface -
    -
    -
    - -
    default @@ -106557,17 +107090,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}

    +
    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
    -

    create or update an existing l-interface

    +

    see node definition for valid relationships

    @@ -106576,13 +107109,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

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /l-interface + /relationship
    @@ -106601,9 +107134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106386,7 +107000,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 @@ -106415,85 +107029,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr + pci-id -

    MAC address for the interface

    +

    PCI ID used to identify the sriov-vf

    		querypath string +
    - network-name + resource-version -

    Name of the network

    +

    resource-version for concurrency

    		 query @@ -106501,6 +107056,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106619,7 +107153,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 @@ -106646,6 +107180,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + pci-id + +

    PCI ID used to identify the sriov-vf

    +     		path + string + + + +
    @@ -106677,17 +107227,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 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 l-interface

    +

    delete an existing relationship

    @@ -106709,9 +107259,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106727,7 +107278,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 @@ -106756,12 +107307,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + pci-id -

    resource-version for concurrency

    +

    PCI ID used to identify the sriov-vf

    		querypath string @@ -106801,17 +107352,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 vlans
    +

    GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    returns vlans

    @@ -106828,9 +107379,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -106846,7 +107398,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 @@ -106875,41 +107427,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + inv-status -

    ID of interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -106921,10 +107442,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -106979,51 +107500,6 @@ 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 - -

    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 - - -
    @@ -107050,7 +107526,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /vlans
    @@ -107078,36 +107554,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    returns 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
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -107122,9 +107581,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -107140,7 +107600,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 @@ -107169,10 +107629,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 @@ -107183,6 +107643,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    +     		query + string + + +
    + prov-status + +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    @@ -107192,6 +107757,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlan +
    +
    +
    + +
    default @@ -107214,23 +107802,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    create or update an existing 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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    @@ -107246,9 +107846,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -107264,7 +107865,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 @@ -107293,10 +107894,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 @@ -107307,22 +107908,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -107354,17 +107939,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing 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
    -

    see node definition for valid relationships

    +

    update an existing vlan

    @@ -107373,13 +107958,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

    +

    vlan object that needs to be created or updated.

    - /relationship + /vlan
    @@ -107398,9 +107983,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -107416,7 +108002,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 @@ -107445,10 +108031,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 @@ -107490,17 +108076,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    delete an existing 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 relationship

    +

    delete an existing vlan

    @@ -107522,9 +108108,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -107540,7 +108127,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 @@ -107569,10 +108156,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 @@ -107583,6 +108170,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -107614,17 +108217,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 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-ipv6-address-list

    +

    returns l3-interface-ipv4-address-list

    @@ -107641,9 +108244,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -107659,7 +108263,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 @@ -107688,10 +108292,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 @@ -107704,25 +108308,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + l3-interface-ipv4-address -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    IP address

    		querypath string +
    - interface-id + inv-status -

    ID of interface

    +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -107734,10 +108339,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -107807,6 +108412,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    neutron-network-id @@ -107863,7 +108498,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -107891,17 +108526,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 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-ipv6-address-list

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -107910,13 +108545,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
    @@ -107935,9 +108570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -107953,7 +108589,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 @@ -107982,7 +108618,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -108027,23 +108679,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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-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
    -

    delete an existing l3-interface-ipv6-address-list

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -108059,9 +108723,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -108077,7 +108742,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 @@ -108106,10 +108771,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 @@ -108122,12 +108787,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -108167,35 +108832,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing l3-interface-ipv4-address-list
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing l3-interface-ipv4-address-list

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -108211,9 +108864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -108229,7 +108883,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 @@ -108258,7 +108912,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -108272,6 +108942,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -108303,23 +108989,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -108335,9 +109033,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -108353,7 +109052,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 @@ -108382,7 +109081,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address

    IP address

    @@ -108427,35 +109142,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -108471,9 +109174,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -108489,7 +109193,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 @@ -108516,88 +109220,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /network/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 + vlan-interface -

    Name that identifies the link aggregate interface

    +

    String that identifies the interface

    		 path @@ -108610,10 +109238,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + l3-interface-ipv4-address -

    Name given to the interface

    +

    IP address

    		 path @@ -108655,17 +109283,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 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 sriov-vfs

    +

    returns l3-interface-ipv6-address-list

    @@ -108682,9 +109310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -108700,7 +109329,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 @@ -108729,25 +109358,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vlan-interface -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    String that identifies the interface

    		querypath string +
    - interface-id + l3-interface-ipv6-address -

    ID of interface

    +

    IP address

    +     		path + string + + + +
    + inv-status + +

    CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

    		 query @@ -108759,10 +109405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-role + prov-status -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -108817,6 +109463,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    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 + + +
    @@ -108843,7 +109564,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /l3-interface-ipv6-address-list
    @@ -108871,19 +109592,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns sriov-vf
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    create or update an existing l3-interface-ipv6-address-list
    +

    PUT /network/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 sriov-vf

    +

    create or update an existing l3-interface-ipv6-address-list

    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    @@ -108898,9 +109636,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -109118,29 +109723,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /sriov-vf -
    -
    -
    - -
    default @@ -109163,17 +109745,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}

    +
    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
    -

    create or update an existing sriov-vf

    +

    update an existing l3-interface-ipv6-address-list

    @@ -109182,13 +109764,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /sriov-vf + /l3-interface-ipv6-address-list
    @@ -109207,9 +109789,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -108916,7 +109655,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 @@ -108945,10 +109684,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    		 path @@ -108961,152 +109700,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - 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 + l3-interface-ipv6-address -

    Neutron network id of the interface

    +

    IP address

    		querypath string +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -109225,7 +109808,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 @@ -109254,10 +109837,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -109299,17 +109898,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 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 sriov-vf

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -109331,9 +109930,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -109349,7 +109949,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 @@ -109378,10 +109978,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -109439,11 +110055,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/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
    @@ -109458,7 +110074,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -109483,9 +110099,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -109501,7 +110118,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 @@ -109530,10 +110147,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -109575,11 +110208,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/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
    @@ -109607,9 +110240,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -109625,7 +110259,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 @@ -109654,10 +110288,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + vlan-interface -

    PCI ID used to identify the sriov-vf

    +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -109699,19 +110349,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    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
    -

    returns vlans

    +

    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/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -109726,9 +110393,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -109870,29 +110464,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlans -
    -
    -
    - -
    default @@ -109915,19 +110486,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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
    -

    returns vlan

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -109744,7 +110412,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 @@ -109773,92 +110441,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name + vlan-interface -

    Name of the network

    +

    String that identifies the interface

    		querypath string +
    @@ -109942,9 +110518,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - equipment-name + pnf-name +

    unique name of Physical Network Function.

    		 path @@ -109960,7 +110537,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 @@ -110003,126 +110580,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    @@ -110132,29 +110589,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /vlan -
    -
    -
    - -
    default @@ -110177,17 +110611,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    create or update an existing vlan

    +

    see node definition for valid relationships

    @@ -110196,13 +110630,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)

    - /vlan + /relationship
    @@ -110221,25 +110655,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + pnf-name -

    Name that identifies the link aggregate interface

    +

    unique name of Physical Network Function.

    		 path @@ -110255,23 +110674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    +

    Name that identifies the physical interface

    		 path @@ -110313,17 +110716,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    Tags: Network
    -

    delete an existing vlan

    +

    delete an existing relationship

    @@ -110345,25 +110748,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + pnf-name -

    Name that identifies the link aggregate interface

    +

    unique name of Physical Network Function.

    		 path @@ -110379,23 +110767,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface - -

    String that identifies the interface

    +

    Name that identifies the physical interface

    		 path @@ -110406,22 +110778,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -110453,19 +110809,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -110480,41 +110853,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 + pnf-name -

    Name given to the interface

    +

    unique name of Physical Network Function.

    		 path @@ -110525,12 +110867,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + +
    - vlan-interface + pnf-name -

    String that identifies the interface

    +

    unique name of Physical Network Function.

    		 path @@ -110541,12 +110944,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    returns route-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

    + +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - l3-interface-ipv4-address + route-table-reference-id -

    IP address

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -110559,160 +111082,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 - - -
    - interface-role - -

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - vpn-id - -

    This indicates the customers VPN ID associated with this vlan

    -     		query - string - - -
    - 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 + route-table-reference-fqdn -

    Neutron id of subnet that address belongs to

    +

    FQDN entry in the route table.

    		 query @@ -110748,7 +111121,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /route-table-reference
    @@ -110776,17 +111149,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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 l3-interface-ipv4-address-list

    +

    create or update an existing route-table-reference

    @@ -110795,13 +111168,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

    +

    route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)

    - /l3-interface-ipv4-address-list + /route-table-reference
    @@ -110820,57 +111193,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 - - - -
    - vlan-interface + route-table-reference-id -

    String that identifies the interface

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -110881,12 +111207,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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 +
    +
    +
    +
    +
    + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - l3-interface-ipv4-address + route-table-reference-id -

    IP address

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -110928,17 +111327,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    delete an existing route-table-reference
    +

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

    Tags: Network
    -

    delete an existing l3-interface-ipv4-address-list

    +

    delete an existing route-table-reference

    @@ -110960,9 +111359,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + route-table-reference-id +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -110975,76 +111375,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-version -

    Name that identifies the link aggregate interface

    +

    resource-version for concurrency

    		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

    -     		queryquery string @@ -111084,11 +111420,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    Tags: Network
    @@ -111103,7 +111439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)

    @@ -111128,73 +111464,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 - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + route-table-reference-id -

    IP address

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -111236,11 +111509,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +

    DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

    Tags: Network
    @@ -111268,73 +111541,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 - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv4-address + route-table-reference-id -

    IP address

    +

    Route Table Reference id, UUID assigned to this instance.

    		 path @@ -111376,278 +111586,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns site-pair-sets
    +

    GET /network/site-pair-sets

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns site-pair-sets

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - 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-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 @@ -111671,7 +111622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /l3-interface-ipv6-address-list + /site-pair-sets
    @@ -111699,36 +111650,19 @@ 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    returns site-pair-set
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    returns site-pair-set

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -111743,73 +111677,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 - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + site-pair-set-id -

    IP address

    +

    Unique id of site pair set.

    		 path @@ -111829,6 +111700,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /site-pair-set +
    +
    +
    + +
    default @@ -111851,23 +111745,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv6-address-list
    -

    DELETE /network/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 site-pair-set
    +

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    delete an existing l3-interface-ipv6-address-list

    +

    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/v9/NetworkSitePairSetsSitePairSet.json)

    +

    +
    +
    +
    +
    + /site-pair-set +
    +
    +
    @@ -111883,73 +111789,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 - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + site-pair-set-id -

    IP address

    +

    Unique id of site pair set.

    		 path @@ -111960,22 +111803,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -112007,17 +111834,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    update an existing site-pair-set
    +

    PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing site-pair-set

    @@ -112026,13 +111853,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

    +

    site-pair-set object that needs to be created or updated.

    - /relationship + /site-pair-set
    @@ -112051,73 +111878,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 - - - -
    - vlan-interface - -

    String that identifies the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + site-pair-set-id -

    IP address

    +

    Unique id of site pair set.

    		 path @@ -112159,17 +111923,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    delete an existing site-pair-set
    +

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing site-pair-set

    @@ -112191,57 +111955,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 - - - -
    - vlan-interface + site-pair-set-id -

    String that identifies the interface

    +

    Unique id of site pair set.

    		 path @@ -112254,12 +111971,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -112299,11 +112016,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    Tags: Network
    @@ -112318,7 +112035,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)

    @@ -112343,57 +112060,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 - - - -
    - vlan-interface + site-pair-set-id -

    String that identifies the interface

    +

    Unique id of site pair set.

    		 path @@ -112435,11 +112105,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +

    DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

    Tags: Network
    @@ -112467,57 +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 - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + site-pair-set-id -

    String that identifies the interface

    +

    Unique id of site pair set.

    		 path @@ -112559,36 +112182,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}/relationship-list/relationship

    +
    returns routing-instances
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns routing-instances

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -112603,25 +112209,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - equipment-name - - path - string - - - -
    - interface-name + site-pair-set-id -

    Name that identifies the link aggregate interface

    +

    Unique id of site pair set.

    		 path @@ -112641,6 +112232,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /routing-instances +
    +
    +
    + +
    default @@ -112663,24 +112277,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}/relationship-list/relationship

    - Tags: +
    returns routing-instance
    +

    GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

    + Tags: Network
    -

    delete an existing relationship

    +

    returns routing-instance

    -
    - -

    application/json application/xml -

    -
    @@ -112695,9 +112304,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -112710,10 +112320,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the link aggregate interface

    +

    Unique id of routing instance

    		 path @@ -112733,6 +112343,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /routing-instance +
    +
    +
    + +
    default @@ -112755,19 +112388,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interfaces
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

    +
    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
    -

    returns p-interfaces

    +

    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/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

    +

    +
    +
    +
    +
    + /routing-instance +
    +
    +
    +
    @@ -112782,9 +112432,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -112819,29 +112471,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interfaces -
    -
    -
    - -
    default @@ -112864,19 +112493,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns p-interface
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    returns p-interface

    +

    update an existing routing-instance

    +
    + +

    application/json application/xml +

    +
    +
    +

    routing-instance object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /routing-instance +
    +
    +
    +
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -112797,17 +112448,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + routing-instance-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique id of routing instance

    		querypath string +
    @@ -112891,9 +112537,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -112906,10 +112553,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -112920,27 +112567,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - + + + + + + + + @@ -112959,29 +112685,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /p-interface -
    -
    -
    - -
    default @@ -113004,17 +112707,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing p-interface
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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
    -

    create or update an existing p-interface

    +

    see node definition for valid relationships

    @@ -113023,13 +112726,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    p-interface object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

    - /p-interface + /relationship
    @@ -113048,9 +112751,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - -
    - prov-status + site-pair-set-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique id of site pair set.

    		querypath string +
    - prov-status + routing-instance-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id of routing instance

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -112948,6 +112673,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113063,10 +112767,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113108,17 +112812,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing p-interface
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    +
    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 p-interface

    +

    delete an existing relationship

    @@ -113140,9 +112844,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113155,10 +112860,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113169,22 +112874,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -113216,17 +112905,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}/p-interfaces/p-interface/{interface-name}/l-interfaces

    +
    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 l-interfaces

    +

    returns site-pairs

    @@ -113243,9 +112932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113258,10 +112948,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113272,36 +112962,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    @@ -113328,7 +112988,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interfaces + /site-pairs
    @@ -113356,17 +113016,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    returns site-pair

    @@ -113383,9 +113043,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113398,10 +113059,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113414,10 +113075,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -113428,81 +113089,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    @@ -113529,7 +113115,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l-interface + /site-pair
    @@ -113557,17 +113143,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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 l-interface

    +

    create or update an existing site-pair

    @@ -113576,13 +113162,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

    +

    site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

    - /l-interface + /site-pair
    @@ -113601,9 +113187,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113616,10 +113203,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113632,10 +113219,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -113677,23 +113264,35 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    +
    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
    -

    delete an existing l-interface

    +

    update an existing site-pair

    application/json application/xml

    +
    +
    +

    site-pair object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /site-pair +
    +
    +
    @@ -113709,9 +113308,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113724,10 +113324,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113740,10 +113340,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -113754,22 +113354,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -113801,19 +113385,24 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    returns l3-interface-ipv4-address-list

    +

    delete an existing site-pair

    +
    + +

    application/json application/xml +

    +
    @@ -113828,9 +113417,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -113843,10 +113433,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -113859,10 +113449,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -113875,12 +113465,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -113889,124 +113479,251 @@ 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 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

    + +
    +
    + + + + + + + + + + + - + - + - + + +
    - prov-status + site-pair-set-id -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique id of site pair set.

    		querypath string +
    - prov-status + routing-instance-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id of routing instance

    		querypath string +
    - interface-id + site-pair-id -

    ID of interface

    +

    unique identifier of probe

    		querypath 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

    + +
    +
    + + + + + + + + + + + - + - + - - - - - - - - + - + @@ -114035,7 +113752,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /class-of-service
    @@ -114063,17 +113780,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}/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 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 l3-interface-ipv4-address-list

    +

    create or update an existing class-of-service

    @@ -114082,13 +113799,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

    +

    class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

    - /l3-interface-ipv4-address-list + /class-of-service
    @@ -114107,9 +113824,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + site-pair-set-id -

    MAC address for the interface

    +

    Unique id of site pair set.

    		querypath string +
    - network-name + routing-instance-id -

    Name of the network

    +

    Unique id of routing instance

    		querypath string +
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id + site-pair-id -

    Neutron network id of the interface that address belongs to

    +

    unique identifier of probe

    		querypath string +
    - neutron-subnet-id + cos -

    Neutron id of subnet that address belongs to

    +

    unique identifier of probe

    		querypath string +
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -114122,10 +113840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -114138,10 +113856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -114154,10 +113872,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -114199,23 +113917,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing l3-interface-ipv4-address-list
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    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
    -

    delete an existing l3-interface-ipv4-address-list

    +

    update an existing class-of-service

    application/json application/xml

    +
    +
    +

    class-of-service object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /class-of-service +
    +
    +
    @@ -114231,9 +113961,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -114246,10 +113977,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -114262,10 +113993,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -114278,10 +114009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -114292,22 +114023,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -114339,35 +114054,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/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 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
    -

    see node definition for valid relationships

    +

    delete an existing class-of-service

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -114383,9 +114086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -114398,10 +114102,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -114414,10 +114118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -114430,10 +114134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -114444,6 +114148,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -114475,23 +114195,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    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
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -114507,9 +114239,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -114522,10 +114255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -114538,10 +114271,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -114554,10 +114287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -114599,19 +114332,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv6-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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
    -

    returns l3-interface-ipv6-address-list

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -114626,9 +114364,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - equipment-name + site-pair-set-id +

    Unique id of site pair set.

    		 path @@ -114641,10 +114380,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name that identifies the physical interface

    +

    Unique id of routing instance

    		 path @@ -114657,10 +114396,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + site-pair-id -

    Name given to the interface

    +

    unique identifier of probe

    		 path @@ -114673,10 +114412,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + cos -

    IP address

    +

    unique identifier of probe

    		 path @@ -114687,126 +114426,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status - -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    -     		query - string - - -
    - prov-status - -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    -     		query - string - - -
    - interface-id - -

    ID of interface

    -     		query - string - - -
    - macaddr - -

    MAC address for the interface

    -     		query - string - - -
    - network-name - -

    Name of the network

    -     		query - string - - -
    - vlan-id-inner - -

    Inner VLAN tag

    -     		query - integer - - -
    - neutron-network-id - -

    Neutron network id of the interface that address belongs to

    -     		query - string - - -
    - neutron-subnet-id - -

    Neutron id of subnet that address belongs to

    -     		query - string - - -
    @@ -114816,29 +114435,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /l3-interface-ipv6-address-list -
    -
    -
    - -
    default @@ -114861,17 +114457,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    see node definition for valid relationships
    +

    PUT /network/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
    -

    create or update an existing l3-interface-ipv6-address-list

    +

    see node definition for valid relationships

    @@ -114880,13 +114476,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

    - /l3-interface-ipv6-address-list + /relationship
    @@ -114905,25 +114501,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + site-pair-set-id -

    Name that identifies the physical interface

    +

    Unique id of site pair set.

    		 path @@ -114936,10 +114517,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name given to the interface

    +

    Unique id of routing instance

    		 path @@ -114952,10 +114533,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + site-pair-id -

    IP address

    +

    unique identifier of probe

    		 path @@ -114997,17 +114578,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    +
    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 l3-interface-ipv6-address-list

    +

    delete an existing relationship

    @@ -115029,25 +114610,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + site-pair-set-id -

    Name that identifies the physical interface

    +

    Unique id of site pair set.

    		 path @@ -115060,10 +114626,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + routing-instance-id -

    Name given to the interface

    +

    Unique id of routing instance

    		 path @@ -115076,10 +114642,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + site-pair-id -

    IP address

    +

    unique identifier of probe

    		 path @@ -115090,22 +114656,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -115137,36 +114687,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    returns vces
    +

    GET /network/vces

    Tags: Network
    -

    see node definition for valid relationships

    +

    returns vces

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    + +
    +

    application/json application/xml +

    + +
    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    -
    -
    -
    - /relationship -
    -
    -
    -
    +
    + +
    +
    + +
    + /vces +
    +
    +
    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    + + +
    +
    + + +
    +
    +
    returns vce
    +

    GET /network/vces/vce/{vnf-id}

    + Tags: + Network +
    +
    +
    +

    returns vce

    + +
    @@ -115181,9 +114778,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -115251,6 +114921,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vce +
    +
    +
    + +
    default @@ -115273,23 +114966,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    create or update an existing vce
    +

    PUT /network/vces/vce/{vnf-id}

    Tags: Network
    -

    delete an existing relationship

    +

    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/v9/NetworkVcesVce.json)

    +

    +
    +
    +
    +
    + /vce +
    +
    +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -115196,50 +114794,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name that identifies the physical interface

    +

    Name of VNF.

    		pathquery string -
    - interface-name + vnf-name2 -

    Name given to the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-type -

    IP address

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery + 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 -
    @@ -115305,57 +115010,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 physical interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - l3-interface-ipv6-address + vnf-id -

    IP address

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -115397,17 +115055,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    update an existing vce
    +

    PATCH /network/vces/vce/{vnf-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    update an existing vce

    @@ -115416,13 +115074,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

    +

    vce object that needs to be created or updated.

    - /relationship + /vce
    @@ -115441,41 +115099,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 physical interface

    -     		path - string - - - -
    - interface-name + vnf-id -

    Name given to the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -115517,17 +115144,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    +
    delete an existing vce
    +

    DELETE /network/vces/vce/{vnf-id}

    Tags: Network
    -

    delete an existing relationship

    +

    delete an existing vce

    @@ -115549,25 +115176,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -115580,12 +115192,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-version -

    Name given to the interface

    +

    resource-version for concurrency

    		pathquery string @@ -115625,17 +115237,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

    +
    returns entitlements
    +

    GET /network/vces/vce/{vnf-id}/entitlements

    Tags: Network
    -

    returns sriov-vfs

    +

    returns entitlements

    @@ -115652,9 +115264,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -115667,42 +115280,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name that identifies the physical interface

    +

    Name of VNF.

    		pathquery string -
    - interface-name + vnf-name2 -

    Name given to the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - prov-status + vnf-type -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -115714,10 +115325,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + service-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		 query @@ -115729,10 +115340,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + regional-resource-zone -

    ID of interface

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -115744,10 +115355,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -115759,10 +115370,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + heat-stack-id -

    Name of the network

    +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + vpe-id + +

    Unique ID of VPE connected to this VCE.

    		 query @@ -115798,7 +115424,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vfs + /entitlements
    @@ -115826,17 +115452,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    returns entitlement
    +

    GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    returns sriov-vf

    +

    returns entitlement

    @@ -115853,25 +115479,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -115884,10 +115495,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -115900,10 +115511,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + resource-uuid -

    PCI ID used to identify the sriov-vf

    +

    Unique ID of an entitlement resource.

    		 path @@ -115916,10 +115527,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vnf-name -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Name of VNF.

    		 query @@ -115931,10 +115542,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vnf-name2 -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Alternate name of VNF.

    		 query @@ -115946,10 +115557,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + vnf-type -

    ID of interface

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -115961,10 +115572,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + service-id -

    MAC address for the interface

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		 query @@ -115976,10 +115587,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + regional-resource-zone -

    Name of the network

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -115991,10 +115602,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-vlan-filter + prov-status -

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -116006,10 +115617,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vf-mac-filter + heat-stack-id -

    When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -116021,25 +115632,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 + vpe-id -

    Neutron network id of the interface

    +

    Unique ID of VPE connected to this VCE.

    		 query @@ -116075,7 +115671,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /sriov-vf + /entitlement
    @@ -116103,17 +115699,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    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 sriov-vf

    +

    create or update an existing entitlement

    @@ -116122,13 +115718,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

    +

    entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)

    - /sriov-vf + /entitlement
    @@ -116147,25 +115743,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -116178,10 +115759,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -116194,10 +115775,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + resource-uuid -

    PCI ID used to identify the sriov-vf

    +

    Unique ID of an entitlement resource.

    		 path @@ -116239,23 +115820,35 @@ 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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

    +
    update an existing entitlement
    +

    PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    delete an existing sriov-vf

    +

    update an existing entitlement

    application/json application/xml

    +
    +
    +

    entitlement object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /entitlement +
    +
    +
    @@ -116271,9 +115864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -116286,10 +115880,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name that identifies the physical interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -116302,10 +115896,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-uuid -

    Name given to the interface

    +

    Unique ID of an entitlement resource.

    		 path @@ -116316,12 +115910,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing entitlement
    +

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

    + Tags: + Network +
    +
    +
    +

    delete an existing entitlement

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - + - + + + + + + + + - + - - - - - - -
    - pci-id + vnf-id -

    PCI ID used to identify the sriov-vf

    +

    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 @@ -116379,11 +116066,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -116398,7 +116085,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)

    @@ -116423,25 +116110,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -116454,10 +116126,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -116470,10 +116142,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + resource-uuid -

    PCI ID used to identify the sriov-vf

    +

    Unique ID of an entitlement resource.

    		 path @@ -116515,11 +116187,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

    +

    DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    @@ -116547,25 +116219,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -116578,10 +116235,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the entitlement group the resource comes from, should be uuid.

    		 path @@ -116594,10 +116251,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pci-id + resource-uuid -

    PCI ID used to identify the sriov-vf

    +

    Unique ID of an entitlement resource.

    		 path @@ -116639,17 +116296,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlans
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    +
    returns licenses
    +

    GET /network/vces/vce/{vnf-id}/licenses

    Tags: Network
    -

    returns vlans

    +

    returns licenses

    @@ -116666,9 +116323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -116681,42 +116339,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name that identifies the physical interface

    +

    Name of VNF.

    		pathquery string -
    - interface-name + vnf-name2 -

    Name given to the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - prov-status + vnf-type -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -116728,10 +116384,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + service-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		 query @@ -116743,10 +116399,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + regional-resource-zone -

    ID of interface

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -116758,10 +116414,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + prov-status -

    MAC address for the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -116773,10 +116429,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + heat-stack-id -

    Name of the network

    +

    Heat stack id corresponding to this instance, managed by MSO

    +     		query + string + + +
    + vpe-id + +

    Unique ID of VPE connected to this VCE.

    		 query @@ -116812,7 +116483,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlans + /licenses
    @@ -116840,17 +116511,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vlan
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    returns license
    +

    GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    returns vlan

    +

    returns license

    @@ -116867,9 +116538,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -116882,10 +116554,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name that identifies the physical interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -116898,10 +116570,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-uuid -

    Name given to the interface

    +

    Unique ID of a license resource.

    		 path @@ -116914,26 +116586,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vnf-name -

    String that identifies the interface

    +

    Name of VNF.

    		pathquery string -
    - prov-status + vnf-name2 -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Alternate name of VNF.

    		 query @@ -116945,10 +116616,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vnf-type -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -116960,10 +116631,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + service-id -

    ID of interface

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		 query @@ -116975,10 +116646,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + regional-resource-zone -

    MAC address for the interface

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -116990,10 +116661,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + prov-status -

    Name of the network

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -117005,14 +116676,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + heat-stack-id -

    Inner VLAN tag

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query - integer + string @@ -117020,10 +116691,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vpe-id -

    This indicates the customers VPN ID associated with this vlan

    +

    Unique ID of VPE connected to this VCE.

    		 query @@ -117059,7 +116730,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vlan + /license
    @@ -117087,17 +116758,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vlan
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    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 vlan

    +

    create or update an existing license

    @@ -117106,13 +116777,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vlan object that needs to be created or updated

    +

    license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)

    - /vlan + /license
    @@ -117131,25 +116802,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117162,10 +116818,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name given to the interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -117178,10 +116834,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-uuid -

    String that identifies the interface

    +

    Unique ID of a license resource.

    		 path @@ -117223,23 +116879,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vlan
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

    +
    update an existing license
    +

    PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    Tags: Network
    -

    delete an existing vlan

    +

    update an existing license

    application/json application/xml

    +
    +
    +

    license object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /license +
    +
    +
    @@ -117255,9 +116923,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117270,10 +116939,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name that identifies the physical interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -117286,10 +116955,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-uuid -

    Name given to the interface

    +

    Unique ID of a license resource.

    		 path @@ -117300,12 +116969,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing license
    +

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

    + Tags: + Network +
    +
    +
    +

    delete an existing license

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    - vlan-interface + vnf-id -

    String that identifies the interface

    +

    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 @@ -117363,19 +117125,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns l3-interface-ipv4-address-list
    -

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    +
    see node definition for valid relationships
    +

    PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    Tags: Network
    -

    returns l3-interface-ipv4-address-list

    +

    see node definition for valid relationships

    +
    + +

    application/json application/xml +

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    @@ -117390,9 +117169,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117405,10 +117185,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + group-uuid -

    Name that identifies the physical interface

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -117421,10 +117201,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + resource-uuid -

    Name given to the interface

    +

    Unique ID of a license resource.

    		 path @@ -117435,12 +117215,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing relationship
    +

    DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + - + + +
    - vlan-interface + vnf-id -

    String that identifies the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117453,10 +117294,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + group-uuid -

    IP address

    +

    Unique ID for the license group the resource belongs to, should be uuid.

    		 path @@ -117469,40 +117310,98 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + resource-uuid -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Unique ID of a license resource.

    		querypath 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

    + +
    +
    + + + + + + + + + + + - +
    - prov-status + vnf-id -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    Unique id of VNF. This is unique across the graph.

    		querypath string +
    - interface-id + vnf-name -

    ID of interface

    +

    Name of VNF.

    		 query @@ -117514,10 +117413,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + vnf-name2 -

    MAC address for the interface

    +

    Alternate name of VNF.

    		 query @@ -117529,10 +117428,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + vnf-type -

    Name of the network

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -117544,14 +117443,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + service-id -

    Inner VLAN tag

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		 query - integer + string @@ -117559,10 +117458,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + regional-resource-zone -

    This indicates the customers VPN ID associated with this vlan

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -117574,14 +117473,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + prov-status -

    Inner VLAN tag

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query - integer + string @@ -117589,10 +117488,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + heat-stack-id -

    Neutron network id of the interface that address belongs to

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -117604,10 +117503,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + vpe-id -

    Neutron id of subnet that address belongs to

    +

    Unique ID of VPE connected to this VCE.

    		 query @@ -117643,7 +117542,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv4-address-list + /port-groups
    @@ -117671,36 +117570,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing l3-interface-ipv4-address-list
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-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 port-group
    +

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    create or update an existing l3-interface-ipv4-address-list

    +

    returns port-group

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv4-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv4-address-list -
    -
    -
    -
    @@ -117715,9 +117597,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - -
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -117730,10 +117613,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the physical interface

    +

    Unique ID of the interface

    		 path @@ -117746,198 +117629,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + vnf-name -

    Name given to the interface

    +

    Name of VNF.

    		pathquery string -
    - vlan-interface + vnf-name2 -

    String that identifies the interface

    +

    Alternate name of VNF.

    		pathquery string -
    - l3-interface-ipv4-address + vnf-type -

    IP address

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    		pathquery 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + + + + + + + + + + + + + + + @@ -117957,6 +117801,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /port-group +
    +
    +
    + +
    default @@ -117979,17 +117846,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    create or update an existing port-group
    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    see node definition for valid relationships

    +

    create or update an existing port-group

    @@ -117998,13 +117865,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

    +

    port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)

    - /relationship + /port-group
    @@ -118023,57 +117890,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - equipment-name + service-id +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		pathquery string -
    - interface-name + regional-resource-zone -

    Name that identifies the physical interface

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - interface-name + prov-status -

    Name given to the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - vlan-interface + heat-stack-id -

    String that identifies the interface

    +

    Heat stack id corresponding to this instance, managed by MSO

    		pathquery string -
    - l3-interface-ipv4-address + vpe-id -

    IP address

    +

    Unique ID of VPE connected to this VCE.

    		pathquery string -
    - resource-version + port-group-id -

    resource-version for concurrency

    +

    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 @@ -117945,7 +117790,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - equipment-name - - path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name - -

    Name given to the interface

    -     		path - string - - - -
    - vlan-interface + vnf-id -

    String that identifies the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -118086,10 +117906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + interface-id -

    IP address

    +

    Unique ID of the interface

    		 path @@ -118131,23 +117951,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

    +
    update an existing port-group
    +

    PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

    Tags: Network
    -

    delete an existing relationship

    +

    update an existing port-group

    application/json application/xml

    +
    +
    +

    port-group object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /port-group +
    +
    +
    @@ -118163,9 +117995,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -118178,10 +118011,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the physical interface

    +

    Unique ID of the interface

    		 path @@ -118192,12 +118025,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    delete an existing 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 +

    +
    +
    + + + + + + + + + + + - + - - - - - - - - - - - - - - - + + + + + + + +
    - interface-name + vnf-id -

    Name given to the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -118210,10 +118104,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + interface-id -

    String that identifies the interface

    +

    Unique ID of the interface

    		 path @@ -118226,12 +118120,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv4-address + resource-version -

    IP address

    +

    resource-version for concurrency

    		pathquery string @@ -118271,17 +118165,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}/p-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 cvlan-tags
    +

    GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

    Tags: Network
    -

    returns l3-interface-ipv6-address-list

    +

    returns cvlan-tags

    @@ -118298,41 +118192,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 physical interface

    -     		path - string - - - -
    - interface-name + vnf-id -

    Name given to the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -118345,10 +118208,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + interface-id -

    String that identifies the interface

    +

    Unique ID of the interface

    		 path @@ -118361,26 +118224,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + vnf-name -

    IP address

    +

    Name of VNF.

    		pathquery string -
    - prov-status + vnf-name2 -

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +

    Alternate name of VNF.

    		 query @@ -118392,10 +118254,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - prov-status + vnf-type -

    Trigger for operational monitoring of this resource by Service Assurance systems.

    +

    String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -118407,10 +118269,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-id + service-id -

    ID of interface

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		 query @@ -118422,10 +118284,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - macaddr + regional-resource-zone -

    MAC address for the interface

    +

    Regional way of organizing pservers, source of truth should define values

    		 query @@ -118437,10 +118299,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-name + prov-status -

    Name of the network

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -118452,14 +118314,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + heat-stack-id -

    Inner VLAN tag

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query - integer + string @@ -118467,10 +118329,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vpe-id -

    This indicates the customers VPN ID associated with this vlan

    +

    Unique ID of VPE connected to this VCE.

    		 query @@ -118482,14 +118344,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-id-inner + port-group-id -

    Inner VLAN tag

    +

    Unique ID for port group in vmware

    		 query - integer + string @@ -118497,10 +118359,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-network-id + switch-name -

    Neutron network id of the interface that address belongs to

    +

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    		 query @@ -118512,10 +118374,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - neutron-subnet-id + heat-stack-id -

    Neutron id of subnet that address belongs to

    +

    Heat stack id corresponding to this instance, managed by MSO

    		 query @@ -118551,7 +118413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /l3-interface-ipv6-address-list + /cvlan-tags
    @@ -118579,36 +118441,19 @@ 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}/p-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 cvlan-tag-entry
    +

    GET /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 l3-interface-ipv6-address-list

    +

    returns cvlan-tag-entry

    -
    - -

    application/json application/xml -

    -
    -
    -

    l3-interface-ipv6-address-list object that needs to be created or updated

    -

    -
    -
    -
    -
    - /l3-interface-ipv6-address-list -
    -
    -
    -
    @@ -118623,9 +118468,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -118638,10 +118484,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the physical interface

    +

    Unique ID of the interface

    		 path @@ -118654,14 +118500,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + cvlan-tag -

    Name given to the interface

    +

    See mis-na-virtualization-platform.yang

    		 path - string + integer @@ -118670,182 +118516,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + vnf-name -

    String that identifies the interface

    +

    Name of VNF.

    		pathquery string -
    - l3-interface-ipv6-address + vnf-name2 -

    IP address

    +

    Alternate name of VNF.

    		pathquery 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 + 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.

    		pathquery string -
    - interface-name + service-id -

    Name that identifies the physical interface

    +

    Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

    		pathquery string -
    - interface-name + regional-resource-zone -

    Name given to the interface

    +

    Regional way of organizing pservers, source of truth should define values

    		pathquery string -
    - vlan-interface + prov-status -

    String that identifies the interface

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		pathquery string -
    - l3-interface-ipv6-address + heat-stack-id -

    IP address

    +

    Heat stack id corresponding to this instance, managed by MSO

    		pathquery string -
    - resource-version + vpe-id -

    resource-version for concurrency

    +

    Unique ID of VPE connected to this VCE.

    		 query @@ -118853,159 +118632,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    see node definition for valid relationships
    -

    PUT /network/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 -
    -
    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -119017,6 +118688,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /cvlan-tag-entry +
    +
    +
    + +
    default @@ -119039,23 +118733,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

    +
    create or update an existing cvlan-tag-entry
    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

    Tags: Network
    -

    delete an existing relationship

    +

    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/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

    +

    +
    +
    +
    +
    + /cvlan-tag-entry +
    +
    +
    - equipment-name - - path - string - - - -
    - interface-name - -

    Name that identifies the physical interface

    -     		path - string - - - -
    - interface-name + port-group-id -

    Name given to the interface

    +

    Unique ID for port group in vmware

    		pathquery string -
    - vlan-interface + switch-name -

    String that identifies the interface

    +

    DVS or standard switch name (should be non-null for port groups associated with DVS)

    		pathquery string -
    - l3-interface-ipv6-address + heat-stack-id -

    IP address

    +

    Heat stack id corresponding to this instance, managed by MSO

    		pathquery string -
    @@ -119071,41 +118777,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 physical interface

    -     		path - string - - - -
    - interface-name + vnf-id -

    Name given to the interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -119118,10 +118793,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + interface-id -

    String that identifies the interface

    +

    Unique ID of the interface

    		 path @@ -119134,14 +118809,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - l3-interface-ipv6-address + cvlan-tag -

    IP address

    +

    See mis-na-virtualization-platform.yang

    		 path - string + integer @@ -119179,17 +118854,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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
    -

    see node definition for valid relationships

    +

    update an existing cvlan-tag-entry

    @@ -119198,13 +118873,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

    +

    cvlan-tag-entry object that needs to be created or updated.

    - /relationship + /cvlan-tag-entry
    @@ -119223,25 +118898,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name - - path - string - - - -
    - interface-name + vnf-id -

    Name that identifies the physical interface

    +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -119254,10 +118914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name given to the interface

    +

    Unique ID of the interface

    		 path @@ -119270,14 +118930,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + cvlan-tag -

    String that identifies the interface

    +

    See mis-na-virtualization-platform.yang

    		 path - string + integer @@ -119315,17 +118975,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

    +
    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 relationship

    +

    delete an existing cvlan-tag-entry

    @@ -119347,9 +119007,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -119362,10 +119023,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the physical interface

    +

    Unique ID of the interface

    		 path @@ -119378,14 +119039,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + cvlan-tag -

    Name given to the interface

    +

    See mis-na-virtualization-platform.yang

    		 path - string + integer @@ -119394,12 +119055,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vlan-interface + resource-version -

    String that identifies the interface

    +

    resource-version for concurrency

    		pathquery string @@ -119439,11 +119100,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

    Tags: Network
    @@ -119458,7 +119119,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

    @@ -119483,9 +119144,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -119498,10 +119160,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the physical interface

    +

    Unique ID of the interface

    		 path @@ -119512,6 +119174,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    @@ -119543,11 +119221,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/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
    @@ -119575,9 +119253,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    		 path @@ -119590,10 +119269,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - interface-name + interface-id -

    Name that identifies the physical interface

    +

    Unique ID of the interface

    		 path @@ -119604,6 +119283,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + cvlan-tag + +

    See mis-na-virtualization-platform.yang

    +     		path + integer + + + +
    @@ -119635,11 +119330,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    +

    PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    Tags: Network
    @@ -119654,7 +119349,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)

    @@ -119679,9 +119374,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + + +
    + interface-id + +

    Unique ID of the interface

    		 path @@ -119723,11 +119435,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

    +

    DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

    Tags: Network
    @@ -119755,9 +119467,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - equipment-name + vnf-id + +

    Unique id of VNF. This is unique across the graph.

    +     		path + string + + +
    + interface-id + +

    Unique ID of the interface

    		 path @@ -119799,17 +119528,183 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns vpn-bindings
    -

    GET /network/vpn-bindings

    +
    see node definition for valid relationships
    +

    PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

    Tags: Network
    -

    returns vpn-bindings

    +

    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/v9/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

    @@ -119835,7 +119730,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vpn-bindings + /vnfcs
    @@ -119863,17 +119758,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vpn-binding
    -

    GET /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    returns vnfc
    +

    GET /network/vnfcs/vnfc/{vnfc-name}

    Tags: Network
    -

    returns vpn-binding

    +

    returns vnfc

    @@ -119890,10 +119785,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vnfc-name -

    VPN ID, globally unique within A&AI

    +

    Unique ID of vnfc.

    		 path @@ -119906,10 +119801,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-name + vnfc-function-code -

    VPN Name

    +

    function code

    		 query @@ -119921,10 +119816,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - global-route-target + vnfc-type -

    Number used to identify a VPN, globally unique in the network

    +

    type

    		 query @@ -119936,10 +119831,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-type + prov-status -

    Type of the vpn, should be taken from enumerated/valid values

    +

    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 @@ -119975,7 +119928,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vpn-binding + /vnfc
    @@ -120003,17 +119956,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vpn-binding
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    create or update an existing vnfc
    +

    PUT /network/vnfcs/vnfc/{vnfc-name}

    Tags: Network
    -

    create or update an existing vpn-binding

    +

    create or update an existing vnfc

    @@ -120022,13 +119975,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vpn-binding object that needs to be created or updated

    +

    vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)

    - /vpn-binding + /vnfc
    @@ -120047,10 +120000,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vnfc-name -

    VPN ID, globally unique within A&AI

    +

    Unique ID of vnfc.

    		 path @@ -120092,23 +120045,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vpn-binding
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

    +
    update an existing vnfc
    +

    PATCH /network/vnfcs/vnfc/{vnfc-name}

    Tags: Network
    -

    delete an existing vpn-binding

    +

    update an existing vnfc

    application/json application/xml

    +
    +
    +

    vnfc object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vnfc +
    +
    +
    @@ -120124,10 +120089,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
    - vpn-id + vnfc-name -

    VPN ID, globally unique within A&AI

    +

    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 @@ -120185,11 +120227,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    see node definition for valid relationships
    -

    PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    +

    PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    Tags: Network
    @@ -120204,7 +120246,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)

    @@ -120229,10 +120271,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vnfc-name -

    VPN ID, globally unique within A&AI

    +

    Unique ID of vnfc.

    		 path @@ -120274,11 +120316,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

    +

    DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

    Tags: Network
    @@ -120306,10 +120348,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vpn-id + vnfc-name -

    VPN ID, globally unique within A&AI

    +

    Unique ID of vnfc.

    		 path @@ -120351,17 +120393,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns zones
    -

    GET /network/zones

    +
    returns vpls-pes
    +

    GET /network/vpls-pes

    Tags: Network
    -

    returns zones

    +

    returns vpls-pes

    @@ -120387,7 +120429,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /zones + /vpls-pes
    @@ -120415,17 +120457,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns zone
    -

    GET /network/zones/zone/{zone-id}

    +
    returns vpls-pe
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    returns zone

    +

    returns vpls-pe

    @@ -120442,10 +120484,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - zone-id + equipment-name -

    Code assigned by AIC to the zone

    		 path @@ -120458,25 +120499,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - design-type - -

    Design of zone [Medium/Large?]

    -     		query - string - - -
    - zone-context + prov-status -

    Context of zone [production/test]

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -120512,7 +120538,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /zone + /vpls-pe
    @@ -120540,17 +120566,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing zone
    -

    PUT /network/zones/zone/{zone-id}

    +
    create or update an existing vpls-pe
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    create or update an existing zone

    +

    create or update an existing vpls-pe

    @@ -120559,13 +120585,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    zone object that needs to be created or updated

    +

    vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)

    - /zone + /vpls-pe
    @@ -120584,10 +120610,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - zone-id + equipment-name -

    Code assigned by AIC to the zone

    		 path @@ -120629,23 +120654,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing zone
    -

    DELETE /network/zones/zone/{zone-id}

    +
    update an existing vpls-pe
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    delete an existing zone

    +

    update an existing vpls-pe

    application/json application/xml

    +
    +
    +

    vpls-pe object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /vpls-pe +
    +
    +
    @@ -120661,10 +120698,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - zone-id + equipment-name -

    Code assigned by AIC to the zone

    		 path @@ -120675,22 +120711,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -120722,35 +120742,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /network/zones/zone/{zone-id}/relationship-list/relationship

    +
    delete an existing vpls-pe
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}

    Tags: Network
    -

    see node definition for valid relationships

    +

    delete an existing vpls-pe

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -120766,10 +120774,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - zone-id + equipment-name -

    Code assigned by AIC to the zone

    		 path @@ -120780,6 +120787,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -120811,24 +120834,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    delete an existing relationship
    -

    DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

    +
    returns lag-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

    Tags: Network
    -

    delete an existing relationship

    +

    returns lag-interfaces

    -
    - -

    application/json application/xml -

    -
    @@ -120843,10 +120861,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
    - zone-id + equipment-name -

    Code assigned by AIC to the zone

    		 path @@ -120857,51 +120874,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 + + +
    -
    -

    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

    @@ -120924,7 +120915,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /models + /lag-interfaces
    @@ -120952,17 +120943,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns model
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}

    +
    returns lag-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    returns model

    +

    returns lag-interface

    @@ -120979,10 +120970,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -120995,10 +120985,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    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 @@ -121034,7 +121070,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model + /lag-interface
    @@ -121062,17 +121098,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing model
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}

    +
    create or update an existing lag-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    create or update an existing model

    +

    create or update an existing lag-interface

    @@ -121081,13 +121117,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model object that needs to be created or updated

    +

    lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

    - /model + /lag-interface
    @@ -121106,10 +121142,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the link aggregate interface

    		 path @@ -121151,23 +121202,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing model
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}

    +
    update an existing lag-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing model

    +

    update an existing lag-interface

    application/json application/xml

    +
    +
    +

    lag-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /lag-interface +
    +
    +
    @@ -121183,10 +121246,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -121199,12 +121261,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name that identifies the link aggregate interface

    		querypath string @@ -121244,19 +121306,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-vers
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

    +
    delete an existing lag-interface
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    returns model-vers

    +

    delete an existing lag-interface

    +
    + +

    application/json application/xml +

    +
    @@ -121271,10 +121338,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + @@ -121309,29 +121392,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-vers -
    -
    -
    - -
    default @@ -121354,17 +121414,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-ver
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

    +
    returns l-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

    Tags: - ServiceDesignAndCreation + Network
    -

    returns model-ver

    +

    returns l-interfaces

    @@ -121381,10 +121441,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -121287,10 +121353,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    		 query @@ -121298,6 +121380,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -121397,10 +121456,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -121413,10 +121472,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + prov-status -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -121428,10 +121487,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + interface-id -

    Name of the model, which can change from version to version.

    +

    ID of interface

    		 query @@ -121443,10 +121502,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + interface-role -

    Version

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		 query @@ -121482,7 +121541,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-ver + /l-interfaces
    @@ -121510,36 +121569,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing model-ver
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

    +
    returns l-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    create or update an existing model-ver

    +

    returns l-interface

    -
    - -

    application/json application/xml -

    -
    -
    -

    model-ver object that needs to be created or updated

    -

    -
    -
    -
    -
    - /model-ver -
    -
    -
    -
    @@ -121554,26 +121596,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - -
    - model-invariant-id - -

    Unique identifier corresponding to the main definition of a model in ASDC

    -     		path - string - - - -
    - model-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -121584,73 +121609,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing 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 + interface-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -121663,10 +121627,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name given to the interface

    		 path @@ -121679,10 +121643,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + prov-status -

    resource-version for concurrency

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -121690,103 +121654,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns metadata
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    returns metadata

    - -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + - -
    - model-invariant-id + interface-id -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    ID of interface

    		pathquery string -
    - model-version-id + interface-role -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - model-type + interface-id -

    Type of the model, e.g., service, resource, widget, etc.

    +

    ID of interface

    		 query @@ -121798,10 +121703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + macaddr -

    Name of the model, which can change from version to version.

    +

    MAC address for the interface

    		 query @@ -121813,10 +121718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + network-name -

    Version

    +

    Name of the network

    		 query @@ -121852,7 +121757,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /metadata + /l-interface
    @@ -121880,19 +121785,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns metadatum
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns metadatum

    +

    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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    +
    @@ -121907,10 +121829,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -121923,10 +121844,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -121939,9 +121860,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + interface-name +

    Name given to the interface

    		 path @@ -121952,51 +121874,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type - -

    Type of the model, e.g., service, resource, widget, etc.

    -     		query - string - - -
    - model-name - -

    Name of the model, which can change from version to version.

    -     		query - string - - -
    - model-version - -

    Version

    -     		query - string - - -
    @@ -122006,29 +121883,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /metadatum -
    -
    -
    - -
    default @@ -122051,17 +121905,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing metadatum

    +

    update an existing l-interface

    @@ -122070,13 +121924,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    metadatum object that needs to be created or updated

    +

    l-interface object that needs to be created or updated.

    - /metadatum + /l-interface
    @@ -122095,10 +121949,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -122111,10 +121964,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -122127,9 +121980,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + interface-name +

    Name given to the interface

    		 path @@ -122171,17 +122025,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete 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 l-interface
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing metadatum

    +

    delete an existing l-interface

    @@ -122203,10 +122057,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -122219,10 +122072,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -122235,9 +122088,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metaname + interface-name +

    Name given to the interface

    		 path @@ -122295,17 +122149,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns model-elements
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model-elements

    +

    returns l3-interface-ipv4-address-list

    @@ -122322,10 +122176,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -122338,10 +122191,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -122354,25 +122207,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name given to the interface

    		querypath string +
    - model-name + l3-interface-ipv4-address -

    Name of the model, which can change from version to version.

    +

    IP address

    +     		path + string + + + +
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -122384,10 +122254,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + interface-id -

    Version

    +

    ID of interface

    		 query @@ -122397,138 +122267,57 @@ 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-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    returns model-element

    - -
    -
    - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + +
    - model-invariant-id + interface-role -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - model-version-id + interface-id -

    Unique identifier corresponding to one version of a model in ASDC

    +

    ID of interface

    		pathquery string -
    - model-element-uuid + macaddr +

    MAC address for the interface

    		pathquery string -
    - model-type + network-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name of the network

    		 query @@ -122540,10 +122329,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + vlan-id-inner -

    Name of the model, which can change from version to version.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -122555,10 +122359,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + neutron-subnet-id -

    Version

    +

    Neutron id of subnet that address belongs to

    		 query @@ -122594,7 +122398,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /model-element + /l3-interface-ipv4-address-list
    @@ -122622,17 +122426,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing model-element

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -122641,13 +122445,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    model-element object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /model-element + /l3-interface-ipv4-address-list
    @@ -122666,10 +122470,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -122682,10 +122485,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -122698,9 +122501,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + l3-interface-ipv4-address +

    IP address

    		 path @@ -122742,23 +122562,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing model-element

    +

    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 +
    +
    +
    @@ -122774,10 +122606,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -122790,10 +122621,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -122806,9 +122637,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -122821,12 +122653,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -122866,19 +122698,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model-constraints

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -122893,10 +122730,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -122992,29 +122816,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-constraints -
    -
    -
    - -
    default @@ -123037,19 +122838,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns model-constraint

    +

    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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -122909,10 +122745,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -122925,9 +122761,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -122940,40 +122777,26 @@ 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 + l3-interface-ipv4-address -

    Name of the model, which can change from version to version.

    +

    IP address

    		querypath string +
    - model-version + resource-version -

    Version

    +

    resource-version for concurrency

    		 query @@ -122981,6 +122804,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    @@ -123064,10 +122882,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -123080,10 +122897,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -123096,9 +122913,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -123111,9 +122929,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + l3-interface-ipv4-address +

    IP address

    		 path @@ -123124,51 +122943,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-type - -

    Type of the model, e.g., service, resource, widget, etc.

    -     		query - string - - -
    - model-name - -

    Name of the model, which can change from version to version.

    -     		query - string - - -
    - model-version - -

    Version

    -     		query - string - - -
    @@ -123178,29 +122952,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /model-constraint -
    -
    -
    - -
    default @@ -123223,35 +122974,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    create or update an existing model-constraint
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing model-constraint

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    model-constraint object that needs to be created or updated

    -

    -
    -
    -
    -
    - /model-constraint -
    -
    -
    @@ -123267,10 +123006,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -123283,10 +123021,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -123299,9 +123037,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -123314,9 +123053,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + l3-interface-ipv4-address +

    IP address

    		 path @@ -123358,24 +123098,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing model-constraint
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

    +
    returns 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: - ServiceDesignAndCreation + Network
    -

    delete an existing model-constraint

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    @@ -123390,10 +123125,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -123406,10 +123140,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -123422,9 +123156,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -123437,9 +123172,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + l3-interface-ipv6-address +

    IP address

    		 path @@ -123452,10 +123188,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + prov-status -

    resource-version for concurrency

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -123463,133 +123199,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    returns 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 + interface-id -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    ID of interface

    		pathquery string -
    - model-version-id + interface-role -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - model-element-uuid + interface-id +

    ID of interface

    		pathquery string -
    - model-constraint-uuid + macaddr +

    MAC address for the interface

    		pathquery string -
    - model-type + network-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name of the network

    		 query @@ -123601,10 +123278,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + vlan-id-inner -

    Name of the model, which can change from version to version.

    +

    Inner VLAN tag

    +     		query + integer + + +
    + neutron-network-id + +

    Neutron network id of the interface that address belongs to

    		 query @@ -123616,10 +123308,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + neutron-subnet-id -

    Version

    +

    Neutron id of subnet that address belongs to

    		 query @@ -123655,7 +123347,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /constrained-element-sets + /l3-interface-ipv6-address-list
    @@ -123683,19 +123375,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns constrained-element-set
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    +
    create or update an existing 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: - ServiceDesignAndCreation + Network
    -

    returns constrained-element-set

    +

    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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    @@ -123710,10 +123419,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -123726,10 +123434,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -123742,9 +123450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -123757,9 +123466,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + l3-interface-ipv6-address +

    IP address

    		 path @@ -123770,9 +123480,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    update an existing l3-interface-ipv6-address-list
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

    + Tags: + Network +
    +
    +
    +

    update an existing l3-interface-ipv6-address-list

    + +
    +
    + +

    application/json application/xml +

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    +
    +
    + + + + + + + + + + + @@ -123787,47 +123570,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -123839,29 +123625,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /constrained-element-set -
    -
    -
    - -
    default @@ -123884,35 +123647,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing constrained-element-set
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing constrained-element-set

    +

    delete an existing l3-interface-ipv6-address-list

    application/json application/xml

    -
    -
    -

    constrained-element-set object that needs to be created or updated

    -

    -
    -
    -
    -
    - /constrained-element-set -
    -
    -
    - constrained-element-set-uuid + equipment-name
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - model-name + interface-name -

    Name of the model, which can change from version to version.

    +

    Name given to the interface

    		querypath string +
    - model-version + l3-interface-ipv6-address -

    Version

    +

    IP address

    		querypath string +
    @@ -123928,10 +123679,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -123944,10 +123694,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -123960,9 +123710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -123975,9 +123726,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + l3-interface-ipv6-address +

    IP address

    		 path @@ -123990,11 +123742,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + resource-version +

    resource-version for concurrency

    		pathquery string @@ -124034,23 +123787,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing constrained-element-set
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing constrained-element-set

    +

    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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -124066,26 +123831,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
    - model-invariant-id - -

    Unique identifier corresponding to the main definition of a model in ASDC

    -     		path - string - - - -
    - model-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -124098,9 +123846,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -124113,9 +123862,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -124128,9 +123878,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + l3-interface-ipv6-address +

    IP address

    		 path @@ -124141,22 +123892,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -124188,19 +123923,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns element-choice-sets
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns element-choice-sets

    +

    delete an existing relationship

    +
    + +

    application/json application/xml +

    +
    @@ -124215,10 +123955,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -124231,10 +123970,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -124247,9 +123986,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -124262,9 +124002,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + l3-interface-ipv6-address +

    IP address

    		 path @@ -124275,9 +124016,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + +
    +

    application/json application/xml +

    + +
    +
    + default + +
    +
    +
    +
    +

    Response codes found in response codes.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    see node definition for valid relationships
    +

    PUT /network/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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    +
    +
    + + + + + + + + + + + @@ -124292,47 +124106,142 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + +
    - constrained-element-set-uuid + equipment-name
    - model-type + interface-name -

    Type of the model, e.g., service, resource, widget, etc.

    +

    Name that identifies the link aggregate interface

    		querypath string +
    - model-name + interface-name -

    Name of the model, which can change from version to version.

    +

    Name given to the 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}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

    + Tags: + Network +
    +
    +
    +

    delete an existing relationship

    + +
    +
    + +

    application/json application/xml +

    +
    +
    + + + + + + + + + + + + + + + - + + + + + + + + @@ -124344,29 +124253,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /element-choice-sets -
    -
    -
    - -
    default @@ -124389,17 +124275,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns element-choice-set
    -

    GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns element-choice-set

    +

    returns sriov-vfs

    @@ -124416,10 +124302,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + - + - +
    + equipment-name + + path string +
    - model-version + interface-name -

    Version

    +

    Name that identifies the link aggregate interface

    		querypath + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path string +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -124432,10 +124317,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -124448,9 +124333,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -124463,55 +124349,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + prov-status +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - constrained-element-set-uuid + interface-id +

    ID of interface

    		pathquery string -
    - element-choice-set-uuid + interface-role +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - model-type + interface-id -

    Type of the model, e.g., service, resource, widget, etc.

    +

    ID of interface

    		 query @@ -124523,10 +124409,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-name + macaddr -

    Name of the model, which can change from version to version.

    +

    MAC address for the interface

    		 query @@ -124538,10 +124424,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version + network-name -

    Version

    +

    Name of the network

    		 query @@ -124577,7 +124463,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /element-choice-set + /sriov-vfs
    @@ -124605,36 +124491,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing element-choice-set
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing element-choice-set

    +

    returns sriov-vf

    -
    - -

    application/json application/xml -

    -
    -
    -

    element-choice-set object that needs to be created or updated

    -

    -
    -
    -
    -
    - /element-choice-set -
    -
    -
    -
    @@ -124649,10 +124518,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -124665,10 +124533,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -124681,9 +124549,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -124696,9 +124565,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + pci-id +

    PCI ID used to identify the sriov-vf

    		 path @@ -124711,193 +124581,145 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + prov-status +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - element-choice-set-uuid + interface-id +

    ID of interface

    		pathquery 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 -

    -
    -
    - - - - - - - - - - - - + - + - + - + - + - + + + + + + + + @@ -124917,6 +124738,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /sriov-vf +
    +
    +
    + +
    default @@ -124939,17 +124783,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    create or update an existing sriov-vf

    @@ -124958,13 +124802,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

    +

    sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    - /relationship + /sriov-vf
    @@ -124983,39 +124827,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - - - - - - - - - - - - - @@ -125030,9 +124842,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-invariant-id + interface-role -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - model-version-id + interface-id -

    Unique identifier corresponding to one version of a model in ASDC

    +

    ID of interface

    		pathquery string -
    - model-element-uuid + macaddr +

    MAC address for the interface

    		pathquery string -
    - model-constraint-uuid + network-name +

    Name of the network

    		pathquery string -
    - constrained-element-set-uuid + vf-vlan-filter +

    This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

    		pathquery string -
    - element-choice-set-uuid + 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.

    		pathquery string -
    - resource-version + vf-vlan-strip -

    resource-version for concurrency

    +

    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 @@ -124905,7 +124727,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
    - 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 + equipment-name
    - model-constraint-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -125045,9 +124858,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + interface-name +

    Name given to the interface

    		 path @@ -125060,9 +124874,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - element-choice-set-uuid + pci-id +

    PCI ID used to identify the sriov-vf

    		 path @@ -125104,23 +124919,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    update an existing sriov-vf

    application/json application/xml

    +
    +
    +

    sriov-vf object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /sriov-vf +
    +
    +
    @@ -125136,39 +124963,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -125183,9 +124978,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - 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 + equipment-name
    - model-constraint-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -125198,9 +124994,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + interface-name +

    Name given to the interface

    		 path @@ -125213,9 +125010,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - element-choice-set-uuid + pci-id +

    PCI ID used to identify the sriov-vf

    		 path @@ -125257,35 +125055,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    delete an existing sriov-vf

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -125301,10 +125087,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -125317,10 +125102,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -125333,9 +125118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -125348,9 +125134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + pci-id +

    PCI ID used to identify the sriov-vf

    		 path @@ -125363,11 +125150,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + resource-version +

    resource-version for concurrency

    		pathquery string @@ -125407,23 +125195,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    see node definition for valid relationships

    application/json application/xml

    +
    +
    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

    +

    +
    +
    +
    +
    + /relationship +
    +
    +
    @@ -125439,26 +125239,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
    - model-invariant-id - -

    Unique identifier corresponding to the main definition of a model in ASDC

    -     		path - string - - - -
    - model-version-id + equipment-name -

    Unique identifier corresponding to one version of a model in ASDC

    		 path @@ -125471,9 +125254,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -125486,9 +125270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -125501,9 +125286,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set-uuid + pci-id +

    PCI ID used to identify the sriov-vf

    		 path @@ -125545,35 +125331,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    delete an existing relationship

    application/json application/xml

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    @@ -125589,10 +125363,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -125605,10 +125378,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -125621,9 +125394,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + pci-id +

    PCI ID used to identify the sriov-vf

    		 path @@ -125665,24 +125455,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

    +
    returns vlans
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    returns vlans

    -
    - -

    application/json application/xml -

    -
    @@ -125697,10 +125482,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -125713,10 +125497,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-version-id + interface-name -

    Unique identifier corresponding to one version of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -125729,9 +125513,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - model-element-uuid + interface-name +

    Name given to the interface

    		 path @@ -125742,202 +125527,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.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    -
    - - - - - - - - - - - - + - + - -
    - model-invariant-id + prov-status -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - model-version-id + interface-id -

    Unique identifier corresponding to one version of a model in ASDC

    +

    ID of interface

    		pathquery string -
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    delete an existing relationship

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - + - + + + + + + + + + + + + + + + @@ -125949,6 +125626,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /vlans +
    +
    +
    + +
    default @@ -125971,36 +125671,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

    +
    returns 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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    returns vlan

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    - model-invariant-id + interface-role -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - model-version-id + interface-id -

    Unique identifier corresponding to one version of a model in ASDC

    +

    ID of interface

    		pathquery + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query string -
    @@ -126015,10 +125698,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - model-invariant-id + equipment-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    		 path @@ -126029,73 +125711,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing relationship
    -

    DELETE /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 + interface-name -

    Unique identifier corresponding to the main definition of a model in ASDC

    +

    Name that identifies the link aggregate interface

    		 path @@ -126106,131 +125727,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    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 + interface-name +

    Name given to the interface

    		 path @@ -126243,9 +125745,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-name + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + prov-status +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		 query @@ -126255,199 +125774,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    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

    -

    -
    -
    -
    -
    - /named-query -
    -
    -
    -
    -
    - - - - - - - - - - - - + - -
    - named-query-uuid + interface-id +

    ID of interface

    		pathquery 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 + interface-role +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    		pathquery string -
    - resource-version + interface-id -

    resource-version for concurrency

    +

    ID of interface

    		 query @@ -126455,85 +125817,59 @@ 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 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 + macaddr +

    MAC address for the interface

    		pathquery string -
    - named-query-name + 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 @@ -126569,7 +125905,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /named-query-elements + /vlan
    @@ -126597,19 +125933,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns named-query-element

    +

    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/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    +

    +
    +
    +
    +
    + /vlan +
    +
    +
    +
    @@ -126624,7 +125977,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -126639,9 +125992,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -126675,29 +126047,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /named-query-element -
    -
    -
    - -
    default @@ -126720,17 +126069,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing named-query-element

    +

    update an existing vlan

    @@ -126739,13 +126088,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    named-query-element object that needs to be created or updated

    +

    vlan object that needs to be created or updated.

    - /named-query-element + /vlan
    @@ -126764,7 +126113,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -126779,9 +126128,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -126870,9 +126252,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -126972,9 +126387,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -126654,16 +126008,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-name + interface-name +

    Name given to the interface

    		querypath + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path string +
    - named-query-uuid + equipment-name
    - named-query-element-uuid + 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 @@ -126823,17 +126205,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing named-query-element

    +

    delete an existing vlan

    @@ -126855,7 +126237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    - named-query-element-uuid + 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 @@ -126930,17 +126345,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns property-constraints

    +

    returns l3-interface-ipv4-address-list

    @@ -126957,7 +126372,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -126987,102 +126403,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-name + interface-name +

    Name given to the interface

    		querypath 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

    - -
    -
    - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -127250,9 +126727,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    - named-query-uuid + vlan-interface +

    String that identifies the interface

    		 path @@ -127095,9 +126435,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-element-uuid + l3-interface-ipv4-address +

    IP address

    		 path @@ -127110,24 +126451,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - property-constraint-uuid + prov-status +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    		pathquery string -
    - named-query-name + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + 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 @@ -127163,7 +126640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /property-constraint + /l3-interface-ipv4-address-list
    @@ -127191,17 +126668,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing property-constraint

    +

    create or update an existing l3-interface-ipv4-address-list

    @@ -127210,13 +126687,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    property-constraint object that needs to be created or updated

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /property-constraint + /l3-interface-ipv4-address-list
    @@ -127235,7 +126712,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -127265,9 +126743,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - property-constraint-uuid + 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 @@ -127309,23 +126820,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing property-constraint

    +

    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 +
    +
    +
    @@ -127341,7 +126864,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -127356,9 +126879,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + +
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -127371,9 +126895,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - property-constraint-uuid + interface-name +

    Name given to the interface

    		 path @@ -127386,12 +126911,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + vlan-interface -

    resource-version for concurrency

    +

    String that identifies the interface

    		querypath + string + + + +
    + l3-interface-ipv4-address + +

    IP address

    +     		path string @@ -127431,19 +126972,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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: - ServiceDesignAndCreation + Network
    -

    returns related-lookups

    +

    delete an existing l3-interface-ipv4-address-list

    +
    + +

    application/json application/xml +

    +
    @@ -127458,7 +127004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -127473,9 +127019,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - -
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -127488,117 +127035,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-name + interface-name +

    Name given to the interface

    		querypath 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

    - -
    -
    - - - - - - - - - - - - - - - - - @@ -127647,29 +127106,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /related-lookup -
    -
    -
    - -
    default @@ -127692,17 +127128,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing related-lookup

    +

    see node definition for valid relationships

    @@ -127711,13 +127147,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    related-lookup object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

    - /related-lookup + /relationship
    @@ -127736,7 +127172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    @@ -127751,9 +127187,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -127857,9 +127327,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -128483,132 +128400,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    - named-query-uuid - - path - string - - - +
    - named-query-element-uuid + vlan-interface +

    String that identifies the interface

    		 path @@ -127611,9 +127067,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - related-lookup-uuid + l3-interface-ipv4-address +

    IP address

    		 path @@ -127626,9 +127083,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-name + resource-version +

    resource-version for concurrency

    		 query @@ -127636,6 +127094,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -127766,9 +127203,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - related-lookup-uuid + 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 @@ -127810,17 +127280,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing related-lookup

    +

    delete an existing relationship

    @@ -127842,7 +127312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -127872,9 +127343,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - related-lookup-uuid + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface +

    String that identifies the interface

    		 path @@ -127887,12 +127375,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + l3-interface-ipv4-address -

    resource-version for concurrency

    +

    IP address

    		querypath string @@ -127932,36 +127420,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/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

    +
    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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    returns l3-interface-ipv6-address-list

    -
    - -

    application/json application/xml -

    -
    -
    -

    relationship object that needs to be created or updated

    -

    -
    -
    -
    -
    - /relationship -
    -
    -
    -
    @@ -127976,7 +127447,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -127991,9 +127462,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -128006,9 +127478,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - related-lookup-uuid + 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 @@ -128019,6 +127524,171 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + prov-status + +

    Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + interface-role + +

    Role assigned to this Interface, should use values as defined in ECOMP Yang models.

    +     		query + string + + +
    + interface-id + +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    +     		query + string + + +
    + vlan-id-inner + +

    Inner VLAN tag

    +     		query + integer + + +
    + vpn-id + +

    This indicates the customers VPN ID associated with this vlan

    +     		query + string + + +
    + 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 + + +
    @@ -128028,6 +127698,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + 200 OK + +
    +
    +
    +
    +

    successful operation

    + +
    +
    +
    + +
    +
    + +
    + /l3-interface-ipv6-address-list +
    +
    +
    + +
    default @@ -128050,23 +127743,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    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

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    create or update an existing l3-interface-ipv6-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    +

    +
    +
    +
    +
    + /l3-interface-ipv6-address-list +
    +
    +
    @@ -128082,7 +127787,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -128097,9 +127802,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -128215,9 +127954,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + @@ -128306,9 +128094,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - named-query-uuid + equipment-name
    - named-query-element-uuid + interface-name +

    Name that identifies the link aggregate interface

    		 path @@ -128112,9 +127818,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - related-lookup-uuid + 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 @@ -128156,17 +127895,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    update an existing l3-interface-ipv6-address-list

    @@ -128175,13 +127914,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

    +

    l3-interface-ipv6-address-list object that needs to be created or updated.

    - /relationship + /l3-interface-ipv6-address-list
    @@ -128200,7 +127939,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    - named-query-element-uuid + 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 @@ -128259,17 +128047,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    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

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    delete an existing l3-interface-ipv6-address-list

    @@ -128291,7 +128079,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    - named-query-element-uuid + 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 @@ -128319,6 +128156,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -128350,13 +128203,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/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: - ServiceDesignAndCreation + Network
    @@ -128369,7 +128222,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

    @@ -128394,9 +128247,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + 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 @@ -128438,13 +128355,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/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: - ServiceDesignAndCreation + Network
    @@ -128470,7 +128387,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - named-query-uuid + equipment-name
    -
    - -
    -

    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 + interface-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Name that identifies the link aggregate interface

    		 path @@ -128621,10 +128418,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    + l3-interface-ipv6-address + +

    IP address

    		 path @@ -128644,29 +128473,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    - 200 OK - -
    -
    -
    -
    -

    successful operation

    - -
    -
    -
    - -
    -
    - -
    - /service-capability -
    -
    -
    - -
    default @@ -128689,17 +128495,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing service-capability
    -

    PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing service-capability

    +

    see node definition for valid relationships

    @@ -128708,13 +128514,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service-capability object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

    - /service-capability + /relationship
    @@ -128733,10 +128539,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -128749,10 +128554,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name that identifies the link aggregate interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    +     		path + string + + + +
    + vlan-interface + +

    String that identifies the interface

    		 path @@ -128794,17 +128631,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing service-capability
    -

    DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing service-capability

    +

    delete an existing relationship

    @@ -128826,10 +128663,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -128842,10 +128678,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name that identifies the link aggregate interface

    		 path @@ -128858,12 +128694,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version + interface-name -

    resource-version for concurrency

    +

    Name given to the interface

    		querypath string @@ -128872,12 +128708,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml +

    + vlan-interface + +

    String that identifies the interface

    +     		path + string + + + +
    +
    + +
    +

    application/json application/xml

    @@ -128903,13 +128755,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    @@ -128922,7 +128774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    relationship object that needs to be created or updated

    +

    relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

    @@ -128947,10 +128799,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -128963,10 +128814,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name that identifies the link aggregate interface

    		 path @@ -129008,13 +128859,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    delete an existing relationship
    -

    DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

    Tags: - ServiceDesignAndCreation + Network
    @@ -129040,10 +128891,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-type + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -129056,10 +128906,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-type + interface-name -

    String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

    +

    Name that identifies the link aggregate interface

    		 path @@ -129101,19 +128951,64 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    returns services
    -

    GET /service-design-and-creation/services

    +
    returns p-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

    Tags: - ServiceDesignAndCreation + Network
    -

    returns services

    +

    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 @@ -129137,7 +129032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /services + /p-interfaces
    @@ -129165,17 +129060,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns service
    -

    GET /service-design-and-creation/services/service/{service-id}

    +
    returns p-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    returns service

    +

    returns p-interface

    @@ -129192,10 +129087,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -129208,10 +129102,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-description + interface-name -

    Description of the service

    +

    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 @@ -129247,7 +129172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /service + /p-interface
    @@ -129275,17 +129200,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing service
    -

    PUT /service-design-and-creation/services/service/{service-id}

    +
    create or update an existing p-interface
    +

    PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    create or update an existing service

    +

    create or update an existing p-interface

    @@ -129294,13 +129219,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    service object that needs to be created or updated

    +

    p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)

    - /service + /p-interface
    @@ -129319,10 +129244,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -129333,73 +129257,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - -
    -

    application/json application/xml -

    - -
    -
    - default - -
    -
    -
    -
    -

    Response codes found in response codes.

    - -
    -
    -
    - -
    -
    - -
    -
    -
    -
    -
    - - -
    -
    -
    delete an existing service
    -

    DELETE /service-design-and-creation/services/service/{service-id}

    - Tags: - ServiceDesignAndCreation -
    -
    -
    -

    delete an existing service

    - -
    -
    - -

    application/json application/xml -

    -
    -
    - - - - - - - - - - - - - - - - - -
    - service-id + interface-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +

    Name that identifies the physical interface

    		 path @@ -129410,22 +129273,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - resource-version - -

    resource-version for concurrency

    -     		query - string - - - -
    @@ -129457,17 +129304,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

    +
    update an existing p-interface
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    update an existing p-interface

    @@ -129476,13 +129323,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

    +

    p-interface object that needs to be created or updated.

    - /relationship + /p-interface
    @@ -129501,10 +129348,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    		 path @@ -129546,17 +129408,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

    +
    delete an existing p-interface
    +

    DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    delete an existing p-interface

    @@ -129578,10 +129440,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - service-id + equipment-name -

    This gets defined by others to provide a unique ID for the service, we accept what is sent.

    		 path @@ -129592,6 +129453,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + resource-version + +

    resource-version for concurrency

    +     		query + string + + + +
    @@ -129623,19 +129516,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vnf-images
    -

    GET /service-design-and-creation/vnf-images

    +
    returns l-interfaces
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

    Tags: - ServiceDesignAndCreation + Network
    -

    returns vnf-images

    +

    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 @@ -129659,7 +129628,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    - /vnf-images + /l-interfaces
    @@ -129687,17 +129656,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - -
    + +
    -
    returns vnf-image
    -

    GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    returns l-interface
    +

    GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

    Tags: - ServiceDesignAndCreation + Network
    -

    returns vnf-image

    +

    returns l-interface

    @@ -129714,10 +129683,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-image-uuid + equipment-name -

    Unique ID of this asset

    		 path @@ -129730,10 +129698,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - application + interface-name -

    The application that the image instantiates.

    +

    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 @@ -129745,10 +129745,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - application-vendor + prov-status -

    The vendor of the application.

    +

    Trigger for operational monitoring of this resource by Service Assurance systems.

    		 query @@ -129760,10 +129760,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - application-version + interface-id -

    The version of the application.

    +

    ID of interface

    +     		query + string + + +
    + macaddr + +

    MAC address for the interface

    +     		query + string + + +
    + network-name + +

    Name of the network

    		 query @@ -129799,7 +129829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - /vnf-image + /l-interface
    @@ -129827,17 +129857,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    create or update an existing vnf-image
    -

    PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    create or update an existing vnf-image

    +

    create or update an existing l-interface

    @@ -129846,13 +129876,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    vnf-image object that needs to be created or updated

    +

    l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

    - /vnf-image + /l-interface
    @@ -129871,10 +129901,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-image-uuid + equipment-name -

    Unique ID of this asset

    +     		path + string + + + +
    + interface-name + +

    Name that identifies the physical interface

    +     		path + string + + + +
    + interface-name + +

    Name given to the interface

    		 path @@ -129916,23 +129977,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing vnf-image
    -

    DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

    +
    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: - ServiceDesignAndCreation + Network
    -

    delete an existing vnf-image

    +

    update an existing l-interface

    application/json application/xml

    +
    +
    +

    l-interface object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l-interface +
    +
    +
    @@ -129948,10 +130021,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + +
    - vnf-image-uuid + equipment-name -

    Unique ID of this asset

    +     		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 @@ -130009,17 +130221,279 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    see node definition for valid relationships
    -

    PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

    +
    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: - ServiceDesignAndCreation + Network
    -

    see node definition for valid relationships

    +

    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

    @@ -130028,13 +130502,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

    +

    l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

    - /relationship + /l3-interface-ipv4-address-list
    @@ -130053,10 +130527,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vnf-image-uuid + equipment-name -

    Unique ID of this asset

    +     		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 @@ -130098,23 +130619,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
    + +
    -
    delete an existing relationship
    -

    DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

    +
    update an existing l3-interface-ipv4-address-list
    +

    PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

    Tags: - ServiceDesignAndCreation + Network
    -

    delete an existing relationship

    +

    update an existing l3-interface-ipv4-address-list

    application/json application/xml

    +
    +
    +

    l3-interface-ipv4-address-list object that needs to be created or updated.

    +

    +
    +
    +
    +
    + /l3-interface-ipv4-address-list +
    +
    +
    @@ -130130,10 +130663,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
    - vnf-image-uuid + equipment-name -

    Unique ID of this asset

    +     		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 @@ -130174,25 +130754,19968 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - -

    Schema definitions

    - -
    -
    -

    action: - object - - - -

    -
    -
    + + +
    +
    +
    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 + + + +
    +
    -
    -
    -
    - action-type: +
    +

    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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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-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. [Valid relationship examples shown here](apidocs/relations/v9/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-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. [Valid relationship examples shown here](apidocs/relations/v9/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/v9/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-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. [Valid relationship examples shown here](apidocs/relations/v9/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/v9/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/v9/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/v9/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.

    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + + +
    +
    +
    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/v9/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 + + +
    + global-route-target + +

    Number used to identify a VPN, globally unique in the network

    +     		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/v9/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/v9/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 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/v9/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/v9/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/v9/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 + + +
    +
    + +
    +

    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/v9/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 + + +
    +
    + +
    +

    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 + + +
    +
    + +
    +

    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/v9/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 + + +
    +
    + +
    +

    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 + + +
    +
    + +
    +

    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/v9/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 + + +
    +
    + +
    +

    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 + + +
    +
    + +
    +

    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/v9/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 + + +
    +
    + +
    +

    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 + + +
    +
    + +
    +

    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/v9/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 + + +
    +
    + +
    +

    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 + + +
    +
    + +
    +

    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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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 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 vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
      • +
    • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
      • +
    • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
      • +
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
      • +
    • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
    + +
    + +
    +
    +
    + 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

    +
    + +
    +
    +
    + persona-model-id: + string + + +
    +
    +

    the ASDC model id for this resource or service model.

    +
    + +
    +
    +
    + persona-model-version: + string + + +
    +
    +

    the ASDC model version for this resource or service model.

    +
    + +
    +
    +
    + model-version-id: + string + + +
    +
    +

    the ASDC model version for this resource or service model.

    +
    + +
    +
    +
    + persona-model-customization-id: + string + + +
    +
    +

    captures the id of all the configuration used to customize the resource for the service.

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Concurrency value

    +
    + +
    +
    +
    + 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-state: + 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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    cloud-region: + object + + + +

    +
    +
    +
    +

    cloud-region designates an installation of a cloud cluster or region or instantiation.

    + +
      +
    • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
      • +
    • TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
      • +
    • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
      • +
    • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
      • +
    • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
      • +
    • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
    + +
    + +
    +
    +
    + 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.

    +
    + +
    +
    +
    + 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 + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    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 oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
      • +
    • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
      • +
    • FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
      • +
    • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
      • +
    • COMPLEX is DELETED when these are DELETED CTAG-POOL
    + +
    + +
    +
    +
    + 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 @@ -130202,8 +150725,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - action-data: +
    + elevation: + string + + +
    +
    +
    + +
    +
    +
    + lata: + string + + +
    +
    +
    + +
    +
    +
    + ctag-pools: object[] @@ -130213,7 +150758,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - action-data + ctag-pool + + + +
    + +
    +
    + +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship @@ -130226,9 +150791,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    action-data: +

    complexes: object @@ -130236,38 +150801,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Collection of physical locations that can house cloud-regions.

    + +
    -
    - property-name: - string +
    + complex: + object[]
    -
    - -
    -
    -
    - property-value: - string - -
    -
    -
    +
    + complex + + + +
    + +
    +
    -
    +
    -

    actions: +

    configuration: object @@ -130276,15 +150843,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    APIs that are more action related than REST (e.g., notify, update).

    +

    Port Mirror Configuration.

    + +
      +
    • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
      • +
    • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
      • +
    • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
      • +
    • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
      • +
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
      • +
    • CONFIGURATION is DELETED when these are DELETED METADATUM
      • +
    • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
    -
    - update: - object +
    + 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

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[]
    @@ -130293,7 +151020,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - update + relationship @@ -130302,9 +151029,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - notify: - object +
    + metadata: + object[]
    @@ -130313,7 +151040,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - notify + metadatum @@ -130326,9 +151053,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    allotted-resource: +

    configurations: object @@ -130337,56 +151064,80 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Represents a slice or partial piece of a resource that gets separately allotted

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    - -
      -
    • TO generic-vnf (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO vlan (Many2Many)
      • -
    • TO tunnel-xconnect (comprises allotted-resource, One2One)
      • -
    • FROM service-instance (is composed of allotted-resource)
      • -
    • FROM service-instance
    +

    Collection of configurations

    -
    - id: - string +
    + configuration: + object[] -
    -

    Allotted Resource id UUID assigned to this instance.

    +
    -
    +
    + configuration + + + +
    + +
    +
    -
    - description: + + +
    +
    +
    +
    +

    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 +
    -

    The descriptive information assigned to this allotted resource instance

    +

    Unique id of resource instance.

    -
    - selflink: +
    + resource-version: string
    -

    Link back to more information in the controller

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    @@ -130427,32 +151178,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - persona-model-customization-id: +
    + widget-model-id: string
    -

    captures the id of all the configuration used to customize the resource for the service.

    +

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    -
    - resource-version: +
    + widget-model-version: string
    -

    Concurrency value

    +

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    -
    - tunnel-xconnects: +
    + relationship-list: object[] @@ -130462,7 +151213,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tunnel-xconnect + relationship @@ -130471,8 +151222,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - relationship-list: +
    + metadata: object[] @@ -130482,7 +151233,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + metadatum @@ -130495,9 +151246,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    allotted-resources: +

    connectors: object @@ -130506,14 +151257,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This object is used to store slices of services being offered

    +

    Collection of resource instances used to connect a variety of disparate inventory widgets

    -
    - allotted-resource: +
    + connector: object[] @@ -130523,7 +151274,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - allotted-resource + connector @@ -130536,9 +151287,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    availability-zone: +

    constrained-element-set: object @@ -130547,58 +151298,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Availability zone, a collection of compute hosts/pservers

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    +

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of availability-zone)
      • -
    • FROM ctag-pool
      • -
    • FROM dvs-switch
      • -
    • FROM generic-vnf
      • -
    • FROM pserver
      • -
    • FROM vce
    +
  • 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
    • -
    - availability-zone-name: +
    + constrained-element-set-uuid: string
    -

    Name of the availability zone. Unique across a cloud region

    -
    - hypervisor-type: +
    + constraint-type: string
    -

    Type of hypervisor. Source of truth should define valid values.

    -
    - operational-state: +
    + check-type: string +
    -

    State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

    @@ -130610,11 +151353,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + element-choice-sets: + object[] + + +
    +
    + +
    + +
    + element-choice-set + + + +
    + +
    +
    +
    relationship-list: object[] @@ -130639,9 +151401,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    availability-zones: +

    constrained-element-sets: object @@ -130649,15 +151411,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of availability zones

    - -
    -
    - availability-zone: +
    + constrained-element-set: object[] @@ -130667,7 +151425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + constrained-element-set @@ -130680,9 +151438,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    az-and-dvs-switches: +

    ctag-assignment: object @@ -130690,12 +151448,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    + +
      +
    • TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
      • +
    • FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    + +
    -
    - dvs-switches: - object +
    + 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[]
    @@ -130704,7 +151494,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - dvs-switches + relationship @@ -130713,9 +151503,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - availability-zone: - object + + +
    +
    +
    +
    +

    ctag-assignments: + object + + + +

    +
    +
    + +
    +
    +
    + ctag-assignment: + object[]
    @@ -130724,7 +151531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + ctag-assignment @@ -130737,9 +151544,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    business: +

    ctag-pool: object @@ -130748,14 +151555,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Namespace for business related constructs

    +

    A collection of C tags (vlan tags) grouped for a specific purpose.

    + +
      +
    • TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
      • +
    • TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
      • +
    • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    -
    - connectors: +
    + 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[] @@ -130765,7 +151640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - connector + relationship @@ -130774,8 +151649,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - customers: + + +
    +
    +
    +
    +

    ctag-pools: + object + + + +

    +
    +
    + +
    +
    +
    + ctag-pool: object[] @@ -130785,7 +151677,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - customer + ctag-pool @@ -130798,9 +151690,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    class-of-service: +

    customer: object @@ -130809,49 +151701,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    customer identifiers to provide linkage back to BSS information.

      -
    • FROM site-pair (is composed of class-of-service)
    +
  • FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
    • +
  • CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
    • -
    - cos: +
    + global-customer-id: string
    -

    unique identifier of probe

    +

    Global customer id used across ECOMP to uniquely identify customer.

    -
    - probe-id: +
    + subscriber-name: string +
    -

    identifier of probe

    +

    Subscriber name, an alternate way to retrieve a customer.

    -
    - probe-type: +
    + subscriber-type: string +
    -

    type of probe

    +

    Subscriber type, a way to provide VID with only the INFRA customers.

    @@ -130868,6 +151762,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + service-subscriptions: + object[] + + +
    +
    + +
    + +
    + service-subscription + + + +
    + +
    +
    +
    relationship-list: object[] @@ -130892,9 +151806,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    classes-of-service: +

    customers: object @@ -130903,14 +151817,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    class-of-service of probe

    +

    Collection of customer identifiers to provide linkage back to BSS information.

    -
    - class-of-service: +
    + customer: object[] @@ -130920,7 +151834,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - class-of-service + customer @@ -130933,9 +151847,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-infrastructure: +

    cvlan-tag-entry: object @@ -130943,35 +151857,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Namespace for cloud infrastructure.

    - -
    -
    - complexes: - 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.

    -
    - complex - - - -
    - -
    -
    +
    -
    - cloud-regions: +
    + relationship-list: object[] @@ -130981,7 +151896,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region + relationship @@ -130990,8 +151905,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - network-profiles: + + +
    +
    +
    +
    +

    cvlan-tags: + object + + + +

    +
    +
    + +
    +
    +
    + cvlan-tag-entry: object[] @@ -131001,7 +151933,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - network-profile + cvlan-tag-entry @@ -131010,8 +151942,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - pservers: + + +
    +
    +
    +
    +

    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[] @@ -131021,7 +152016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - pserver + relationship @@ -131030,8 +152025,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - virtual-data-centers: + + +
    +
    +
    +
    +

    dvs-switches: + object + + + +

    +
    +
    +
    +

    Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

    + +
    + +
    +
    +
    + dvs-switch: object[] @@ -131041,7 +152057,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - virtual-data-center + dvs-switch @@ -131054,9 +152070,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-region: +

    edge-prop-names: object @@ -131065,124 +152081,304 @@ 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.

    -
    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)
      • -
    • TO zone (Many2One)
      • -
    • FROM pserver
      • -
    • FROM logical-link
    +

    Internal map to define the properties of an edge and interpret the map EdgeRules

    -
    - cloud-owner: +
    + edgeLabel: string -
    -

    Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

    -
    - cloud-region-id: +
    + direction: string -
    -

    Identifier used by the vendor for the region. Second part of composite key

    -
    - cloud-type: +
    + multiplicityRule: string
    -

    Type of the cloud (e.g., openstack)

    -
    - owner-defined-type: +
    + isParent: + boolean + + +
    +
    +
    + +
    +
    +
    + usesResource: + boolean + + +
    +
    +
    + +
    +
    +
    + hasDelTarget: + boolean + + +
    +
    +
    + +
    +
    +
    + SVC-INFRA: + boolean + + +
    +
    +
    + +
    +
    +
    + SVC-INFRA-REV: + boolean + + +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +

    edge-tag-query-request: + object + + + +

    +
    +
    + +
    +
    +
    + edge-tag: string
    -

    Cloud-owner defined type indicator (e.g., dcp, lcp)

    -
    - cloud-region-version: +
    + result-detail: string
    -

    Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

    -
    - identity-url: +
    + start-node-type: string
    -

    URL of the keystone identity service

    -
    - cloud-zone: +
    + 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 +
    -

    Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

    -
    - complex-name: +
    + element-choice-set-name: + string + + + +
    +
    +
    + +
    +
    +
    + cardinality: string
    -

    complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

    @@ -131194,13 +152390,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - volume-groups: +
    + model-elements: object[] @@ -131210,7 +152405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - volume-group + model-element @@ -131219,8 +152414,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - tenants: +
    + relationship-list: object[] @@ -131230,7 +152425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tenant + relationship @@ -131239,8 +152434,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - flavors: + + +
    +
    +
    +
    +

    element-choice-sets: + object + + + +

    +
    +
    + +
    +
    +
    + element-choice-set: object[] @@ -131250,7 +152462,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - flavor + element-choice-set @@ -131259,48 +152471,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - group-assignments: - object[] + + +
    +
    +
    +
    +

    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.

    -
    - group-assignment - - - -
    - -
    -
    +
    -
    - snapshots: - object[] +
    + resource-uuid: + string +
    +

    Unique ID of an entitlement resource.

    +
    + +
    +
    +
    + resource-version: + string + +
    +
    +

    Concurrency value

    -
    - snapshot - - - -
    - -
    -
    +
    -
    - images: +
    + relationship-list: object[] @@ -131310,7 +152545,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - image + relationship @@ -131319,8 +152554,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - dvs-switches: + + +
    +
    +
    +
    +

    entitlements: + object + + + +

    +
    +
    +
    +

    Entitlements, keyed by group-uuid and resource-uuid, related to license management

    + +
    + +
    +
    +
    + entitlement: object[] @@ -131330,7 +152586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - dvs-switch + entitlement @@ -131339,29 +152595,59 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - oam-networks: - object[] + + +
    +
    +
    +
    +

    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.

    -
    - oam-network - - - -
    - -
    -
    +
    -
    - availability-zones: - object[] +
    + esr-system-info-list: + object
    @@ -131370,7 +152656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - availability-zone + esr-system-info-list @@ -131381,7 +152667,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -131390,7 +152676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -131403,9 +152689,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cloud-regions: +

    esr-ems-list: object @@ -131416,8 +152702,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - cloud-region: +
    + esr-ems: object[] @@ -131427,7 +152713,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cloud-region + esr-ems @@ -131440,9 +152726,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    +
    -

    complex: +

    esr-system-info: object @@ -131451,246 +152737,261 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of physical locations that can house cloud-regions.

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

    +

    Persist common address information of external systems.

      -
    • TO ctag-pool (comprises complex, Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • FROM availability-zone
      • -
    • FROM cloud-region
      • -
    • FROM oam-network
      • -
    • FROM pserver
      • -
    • FROM pnf
      • -
    • FROM vce
      • -
    • FROM vpls-pe
      • -
    • FROM volume-group
      • -
    • FROM zone
    +
  • FROM 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)
    • -
    - physical-location-id: +
    + esr-system-info-id: string
    -

    Unique identifier for physical location, e.g., CLLI

    +

    Unique ID of esr system info.

    -
    - data-center-code: +
    + system-name: string
    -

    Data center code which can be an alternate way to identify a complex

    +

    name of external system.

    -
    - complex-name: +
    + type: string
    -

    Gamma complex name for LCP instance.

    +

    type of external systems.

    -
    - identity-url: +
    + vendor: string
    -

    URL of the keystone identity service

    +

    vendor of external systems.

    -
    - resource-version: +
    + version: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    version of external systems.

    -
    - physical-location-type: +
    + service-url: string -
    -

    Type, e.g., central office, data center.

    +

    url used to access external systems.

    -
    - street1: +
    + user-name: string
    +

    username used to access external systems.

    -
    - street2: +
    + password: string +
    +

    password used to access external systems.

    -
    - city: +
    + system-type: string
    +

    it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    -
    - state: +
    + protocol: string
    +

    protocol of third party SDNC, for example netconf/snmp.

    -
    - postal-code: +
    + ssl-cacert: string -
    +

    ca file content if enabled ssl on auth-url.

    -
    - country: - string +
    + ssl-insecure: + boolean -
    +

    Whether to verify VIM's certificate.

    -
    - region: +
    + ip-address: string -
    +

    service IP of ftp server.

    -
    - latitude: +
    + port: string
    +

    service port of ftp server.

    -
    - longitude: +
    + cloud-domain: string
    +

    domain info for authentication.

    -
    - elevation: +
    + default-tenant: string
    +

    default tenant of VIM.

    -
    - lata: +
    + passive: + boolean + + +
    +
    +

    ftp passive mode or not.

    +
    + +
    +
    +
    + remote-path: string
    +

    resource or performance data file path.

    -
    - ctag-pools: - object[] +
    + 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.

    -
    - ctag-pool - - - -
    - -
    -
    +
    relationship-list: @@ -131716,9 +153017,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    complexes: +

    esr-system-info-list: object @@ -131727,14 +153028,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Collection of physical locations that can house cloud-regions.

    +

    Collection of persistent block-level external system auth info.

    -
    - complex: +
    + esr-system-info: object[] @@ -131744,7 +153045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - complex + esr-system-info @@ -131757,9 +153058,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    connector: +

    esr-thirdparty-sdnc: object @@ -131768,107 +153069,69 @@ 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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    +

    Persist SDNC address information used by ONAP SDNC.

      -
    • TO virtual-data-center (Many2Many)
      • -
    • TO metadatum (comprises connector, Many2Many)
      • -
    • FROM service-instance
    +
  • 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
    • -
    - resource-instance-id: +
    + thirdparty-sdnc-id: string
    -

    Unique id of resource instance.

    -
    - -
    -
    -
    - resource-version: - string - - -
    -
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - -
    -
    -
    - persona-model-id: - string - - -
    -
    -

    the ASDC model id for this resource or service model.

    -
    - -
    -
    -
    - persona-model-version: - string - - -
    -
    -

    the ASDC model version for this resource or service model.

    +

    Unique ID of SDNC.

    -
    - model-version-id: +
    + location: string
    -

    the ASDC model version for this resource or service model.

    +

    used for DC type to indicate the location of SDNC, such as Core or Edge.

    -
    - widget-model-id: +
    + product-name: string
    -

    the ASDC data dictionary widget model. This maps directly to the A&AI widget.

    +

    password used to access SDNC server.

    -
    - widget-model-version: +
    + resource-version: string
    -

    the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - relationship-list: - object[] +
    + esr-system-info-list: + object
    @@ -131877,7 +153140,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + esr-system-info-list @@ -131886,9 +153149,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - metadata: - object[] +
    + relationship-list: + object
    @@ -131897,7 +153160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metadatum + relationship-list @@ -131910,9 +153173,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    connectors: +

    esr-thirdparty-sdnc-list: object @@ -131920,15 +153183,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

    - -
    -
    - connector: +
    + esr-thirdparty-sdnc: object[] @@ -131938,7 +153197,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - connector + esr-thirdparty-sdnc @@ -131951,9 +153210,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    constrained-element-set: +

    esr-vnfm: object @@ -131962,51 +153221,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This is how we would capture constraints defining allowed sets of elements.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    +

    Persist VNFM address information used by VF-C.

      -
    • TO element-choice-set (comprises constrained-element-set, One2Many)
      • -
    • FROM model-element (is composed of constrained-element-set)
      • -
    • FROM model-constraint (is composed of constrained-element-set)
    +
  • 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
    • -
    - constrained-element-set-uuid: +
    + vnfm-id: string
    +

    Unique ID of VNFM.

    -
    - constraint-type: +
    + vim-id: string -
    +

    indecate the VIM to deploy VNF.

    -
    - check-type: +
    + certificate-url: string -
    +

    certificate url of VNFM.

    @@ -132018,13 +153275,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - element-choice-sets: - object[] +
    + esr-system-info-list: + object
    @@ -132033,7 +153291,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - element-choice-set + esr-system-info-list @@ -132044,7 +153302,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -132053,7 +153311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -132066,9 +153324,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    constrained-element-sets: +

    esr-vnfm-list: object @@ -132079,8 +153337,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - constrained-element-set: +
    + esr-vnfm: object[] @@ -132090,7 +153348,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - constrained-element-set + esr-vnfm @@ -132103,9 +153361,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    +
    -

    ctag-assignment: +

    evc: object @@ -132114,308 +153372,180 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    +

    evc object is an optional child object of the Configuration object.

      -
    • FROM l3-network (is composed of ctag-assignment)
      • -
    • FROM service-instance
    +
  • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    • -
    - vlan-id-inner: - integer +
    + evc-id: + string
    -

    id.

    +

    Unique/key field for the evc object

    -
    - resource-version: +
    + forwarding-path-topology: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    Point-to-Point, Multi-Point

    -
    - relationship-list: - object[] +
    + cir-value: + string
    - +

    Commited Information Rate

    -
    - relationship - - - -
    - -
    -
    +
    -
    -
    -
    -
    -
    -
    -

    ctag-assignments: - object - - - -

    -
    -
    - -
    -
    -
    - ctag-assignment: - object[] +
    + cir-units: + string
    - +

    CIR units

    -
    - ctag-assignment - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    ctag-pool: - object - - - -

    -
    -
    -
    -

    A collection of C tags (vlan tags) grouped for a specific purpose.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - -
      -
    • TO availability-zone (Many2Many)
      • -
    • FROM complex (is composed of ctag-pool)
      • -
    • FROM vpls-pe
    - -
    - -
    -
    -
    - target-pe: +
    + connection-diversity-group-id: string -
    -

    The Target provider edge router

    +

    Diversity Group ID

    -
    - availability-zone-name: +
    + service-hours: string -
    -

    Name of the availability zone

    +

    formerly Performance Group

    -
    - ctag-pool-purpose: +
    + esp-evc-circuit-id: string -
    -

    Describes what the intended purpose of this pool is.

    +

    EVC Circuit ID of ESP EVC

    -
    - ctag-values: +
    + esp-evc-cir-value: string
    -

    Comma separated list of ctags

    +

    Committed Information Rate (For ESP)

    -
    - resource-version: +
    + esp-evc-cir-units: string
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    CIR units (For ESP)

    -
    - relationship-list: - object[] +
    + esp-itu-code: + string
    - +

    Identifies ESP

    -
    - relationship - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    ctag-pools: - object - - - -

    -
    -
    - -
    -
    -
    - ctag-pool: - object[] +
    + collector-pop-clli: + string
    - +

    Collector POP CLLI (from the hostname of the access pnf)

    -
    - ctag-pool - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    customer: - object - - - -

    -
    -
    -
    -

    customer identifiers to provide linkage back to BSS information.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    - -
      -
    • TO service-subscription (comprises customer, Many2Many)
    - -
    - -
    -
    -
    - global-customer-id: +
    + inter-connect-type-ingress: string -
    -

    Global customer id used across ECOMP to uniquely identify customer.

    +

    Interconnect type on ingress side of EVC.

    -
    - subscriber-name: +
    + tagmode-access-ingress: string -
    -

    Subscriber name, an alternate way to retrieve a customer.

    +

    tagode for collector side of EVC

    -
    - subscriber-type: +
    + tagmode-access-egress: string -
    -

    Subscriber type, a way to provide VID with only the INFRA customers.

    +

    tagMode for network side of EVC

    @@ -132427,31 +153557,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - service-subscriptions: - object[] - - -
    -
    - -
    - -
    - service-subscription - - - -
    - -
    -
    -
    relationship-list: object[] @@ -132476,9 +153586,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    customers: +

    evcs: object @@ -132486,15 +153596,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of customer identifiers to provide linkage back to BSS information.

    - -
    -
    - customer: +
    + evc: object[] @@ -132504,7 +153610,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - customer + evc @@ -132517,9 +153623,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    cvlan-tag-entry: +

    external-system: object @@ -132527,37 +153633,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Namespace for external system.

    + +
    -
    - cvlan-tag: - integer +
    + esr-ems-list: + object -
    -

    See mis-na-virtualization-platform.yang

    -
    - -
    -
    -
    - resource-version: - string - -
    -
    -

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    +
    + esr-ems-list + + + +
    + +
    +
    -
    - relationship-list: - object[] +
    + esr-vnfm-list: + object
    @@ -132566,7 +153671,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + esr-vnfm-list @@ -132575,26 +153680,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - - -
    -
    -
    -
    -

    cvlan-tags: - object - - - -

    -
    -
    - -
    -
    -
    - cvlan-tag-entry: - object[] +
    + esr-thirdparty-sdnc-list: + object
    @@ -132603,7 +153691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - cvlan-tag-entry + esr-thirdparty-sdnc-list @@ -132616,9 +153704,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    dvs-switch: +

    extra-properties: object @@ -132627,83 +153715,19 @@ 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.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - -
      -
    • TO availability-zone (Many2Many)
      • -
    • FROM cloud-region (is composed of dvs-switch)
    +

    Extra properties for inventory item for response list

    -
    - 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: +

    extra-property: object @@ -132711,40 +153735,27 @@ 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 GenericVnfs.

    - -
    -
    - dvs-switch: - object[] +
    + property-name: + string
    -
    -
    - dvs-switch - - - -
    - -
    -
    +
    -
    +
    -

    edge-prop-names: +

    flavor: object @@ -132753,192 +153764,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Internal map to define the properties of an edge and interpret the map EdgeRules

    +

    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
    -
    - edgeLabel: +
    + flavor-id: string +
    +

    Flavor id, expected to be unique across cloud-region.

    -
    - direction: +
    + flavor-name: string +
    +

    Flavor name

    -
    - multiplicityRule: - string +
    + flavor-vcpus: + integer
    +

    Number of CPUs

    -
    - isParent: - boolean +
    + flavor-ram: + integer
    +

    Amount of memory

    -
    - usesResource: - boolean +
    + flavor-disk: + integer
    +

    Disk space

    -
    - hasDelTarget: - boolean +
    + flavor-ephemeral: + integer
    +

    Amount of ephemeral disk space

    -
    - SVC-INFRA: - boolean +
    + flavor-swap: + string
    +

    amount of swap space allocation

    -
    - SVC-INFRA-REV: +
    + flavor-is-public: boolean
    +

    whether flavor is available to all users or private to the tenant it was created in.

    -
    -
    -
    -
    -
    -
    -

    edge-tag-query-request: - object - - - -

    -
    -
    - -
    -
    -
    - edge-tag: +
    + flavor-selflink: string +
    +

    URL to endpoint where AAI can get more details

    -
    - result-detail: - string +
    + flavor-disabled: + boolean
    +

    Boolean as to whether this flavor is no longer enabled

    -
    - start-node-type: +
    + resource-version: string
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - start-node-filter: - object[] - - -
    -
    - -
    - -
    - start-node-filter - - - -
    - -
    -
    -
    -
    - include-node-filter: - object[] - - -
    -
    - -
    - -
    - include-node-filter - - - -
    - -
    -
    -
    -
    - secondary-filter: +
    + relationship-list: object[] @@ -132948,7 +153921,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - secondary-filter + relationship @@ -132961,9 +153934,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    edge-tag-query-result: +

    flavors: object @@ -132971,11 +153944,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    Collection of openstack flavors.

    + +
    -
    - tagged-inventory-item-list: +
    + flavor: object[] @@ -132985,7 +153962,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - tagged-inventory-item-list + flavor @@ -132998,9 +153975,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    element-choice-set: +

    forwarder: object @@ -133009,49 +153986,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    This is how we would capture constraints defining allowed sets of elements.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    +

    Entity describing a sequenced segment of forwarding path

      -
    • TO model-element (comprises element-choice-set, One2Many)
      • -
    • FROM constrained-element-set (is composed of element-choice-set)
    +
  • 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
    • -
    - element-choice-set-uuid: - string - - - -
    -
    -
    - -
    -
    -
    - element-choice-set-name: - string +
    + sequence: + integer
    +

    Unique ID of this segmentation

    -
    - cardinality: +
    + forwarder-role: string
    +

    ingress, intermediate, egress

    @@ -133063,30 +154032,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - model-elements: - object[] - - -
    -
    - -
    - -
    - model-element - - - -
    - -
    -
    -
    relationship-list: object[] @@ -133111,9 +154061,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    element-choice-sets: +

    forwarder-evc: object @@ -133121,78 +154071,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    +
    +

    forwarder object is an optional child object of the Configuration object.

    + +
      +
    • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    + +
    -
    - element-choice-set: - object[] +
    + 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

    -
    - element-choice-set - - - -
    - -
    -
    +
    - - -
    -
    -
    -
    -

    entitlement: - object - - - -

    -
    -
    -
    -

    Metadata for entitlement group.

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

    - -
      -
    • FROM generic-vnf (is composed of entitlement)
      • -
    • FROM vce (is composed of entitlement)
    - -
    - -
    -
    -
    - group-uuid: +
    + ivlan: string -
    -

    Unique ID for the entitlement group the resource comes from, should be uuid.

    +

    Internal VLAN.

    -
    - resource-uuid: +
    + svlan: string -
    -

    Unique ID of an entitlement resource.

    +

    SVLAN value for ingress of egress forwarder.

    +
    + +
    +
    +
    + cvlan: + string + + +
    +
    +

    CVLAN value for ingress of egress forwarder.

    @@ -133204,7 +154149,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -

    Concurrency value

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    @@ -133233,9 +154178,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    entitlements: +

    forwarder-evcs: object @@ -133243,15 +154188,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Entitlements, keyed by group-uuid and resource-uuid, related to license management

    - -
    -
    - entitlement: +
    + forwarder-evc: object[] @@ -133261,7 +154202,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - entitlement + forwarder-evc @@ -133274,9 +154215,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    extra-properties: +

    forwarders: object @@ -133284,48 +154225,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Extra properties for inventory item for response list

    - -
    -
    -
    -
    -
    -
    -
    -

    extra-property: - object - - - -

    -
    -
    - -
    -
    -
    - property-name: - string +
    + forwarder: + object[]
    +
    -
    +
    + forwarder + + + +
    + +
    +
    -
    +
    -

    flavor: +

    forwarding-path: object @@ -133334,155 +154263,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -

    Openstack flavor.

    -
    Default Delete Scope
    -

    ERROR_IF_ANY_IN_EDGES

    +

    Entity that describes the sequenced forwarding path between interfaces of services or resources

      -
    • FROM cloud-region (is composed of flavor)
      • -
    • FROM vserver
    +
  • 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
    • -
    - flavor-id: +
    + forwarding-path-id: string
    -

    Flavor id, expected to be unique across cloud-region.

    +

    Unique ID of this FP

    -
    - flavor-name: +
    + forwarding-path-name: string
    -

    Flavor name

    -
    - -
    -
    -
    - flavor-vcpus: - integer - - -
    -
    -

    Number of CPUs

    +

    Name of the FP

    -
    - flavor-ram: - integer - - -
    -
    -

    Amount of memory

    -
    - -
    -
    -
    - flavor-disk: - integer - - -
    -
    -

    Disk space

    -
    - -
    -
    -
    - flavor-ephemeral: - integer - - -
    -
    -

    Amount of ephemeral disk space

    -
    - -
    -
    -
    - flavor-swap: +
    + resource-version: 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.

    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    -
    - flavor-selflink: +
    + selflink: string -
    -

    URL to endpoint where AAI can get more details

    +

    the self link for this FP

    -
    - flavor-disabled: - boolean +
    + relationship-list: + object[]
    -

    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 + + + +
    + +
    +
    -
    - relationship-list: +
    + forwarders: object[] @@ -133492,7 +154357,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + forwarder @@ -133505,9 +154370,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    -

    flavors: +

    forwarding-paths: object @@ -133515,15 +154380,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    -
    -

    Collection of openstack flavors.

    - -
    -
    - flavor: +
    + forwarding-path: object[] @@ -133533,7 +154394,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - flavor + forwarding-path @@ -133558,31 +154419,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General purpose VNF

    -
    Default Delete Scope
    -

    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)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO entitlement (comprises generic-vnf, One2Many)
      • -
    • TO license (comprises generic-vnf, One2Many)
      • -
    • FROM virtual-data-center
      • -
    • FROM logical-link
      • -
    • FROM allotted-resource
    +
  • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • +
  • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
    • +
  • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • +
  • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
    • @@ -134224,13 +155084,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack group-assignment used to store exclusivity groups (EG).

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO tenant (Many2Many)
      • -
    • TO pserver (One2Many)
      • -
    • FROM cloud-region (is composed of group-assignment)
    +
  • 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)
    • @@ -134364,6 +155222,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    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: @@ -134376,13 +155377,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack image.

    -
    Default Delete Scope
    -

    ERROR_4_IN_EDGES_OR_CASCADE

      -
    • TO metadatum (comprises image, Many2Many)
      • -
    • FROM cloud-region (is composed of image)
      • -
    • FROM vserver
    +
  • 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
    • @@ -134700,15 +155701,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General mechanism for grouping instances

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO model (Many2Many)
      • -
    • FROM pnf
      • -
    • FROM allotted-resource
      • -
    • FROM generic-vnf
      • -
    • FROM service-instance
    +
  • 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 pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • @@ -135006,7 +156005,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + aai-internal @@ -135262,12 +156261,11 @@ 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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO vig-server (comprises ipsec-configuration, One2Many)
      • -
    • FROM generic-vnf
    +
  • 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
    • @@ -135670,20 +156668,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical interfaces, e.g., a vnic.

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

      -
    • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
      • -
    • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
      • -
    • 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)
    +
  • 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 logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • +
  • TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • +
  • TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
    • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -135967,14 +156965,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM l-interface (is composed of l3-interface-ipv4-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv4-address-list)
    +
  • 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)
    • @@ -136113,14 +157109,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

    -
    Default Delete Scope
    -

    THIS_NODE_ONLY

      -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • FROM l-interface (is composed of l3-interface-ipv6-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv6-address-list)
    +
  • 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)
    • @@ -136259,25 +157253,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Generic network definition

    -
    Default Delete Scope
    -

    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
      • -
    • FROM tenant
      • -
    • FROM vf-module
      • -
    • FROM allotted-resource
    +
  • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • +
  • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • +
  • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • +
  • FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
    • @@ -136669,9 +157662,326 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    +
    +
    +

    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 p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
      • +
    • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
      • +
    • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
      • +
    • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
      • +
    • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
      • +
    • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
      • +
    • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
    + +
    + +
    +
    +
    + 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.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    + l-interfaces: + object[] + + +
    +
    + +
    + +
    + l-interface + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    lag-interfaces: + object + + + +

    +
    +
    +
    +

    Collection of link aggregate interfaces.

    + +
    + +
    +
    +
    + lag-interface: + object[] + + +
    +
    + +
    + +
    + lag-interface + + + +
    + +
    +
    +
    +
    +
    +
    +
    + +