summaryrefslogtreecommitdiffstats
path: root/vbd/api/src/main/yang
diff options
context:
space:
mode:
Diffstat (limited to 'vbd/api/src/main/yang')
-rw-r--r--vbd/api/src/main/yang/odl-external-reference.yang41
-rw-r--r--vbd/api/src/main/yang/vbridge-topology.yang159
2 files changed, 200 insertions, 0 deletions
diff --git a/vbd/api/src/main/yang/odl-external-reference.yang b/vbd/api/src/main/yang/odl-external-reference.yang
new file mode 100644
index 000000000..e82bfe2b7
--- /dev/null
+++ b/vbd/api/src/main/yang/odl-external-reference.yang
@@ -0,0 +1,41 @@
+module odl-external-reference {
+ // vi: set et smarttab sw=4 tabstop=4:
+
+ yang-version 1;
+ // FIXME: this mode should go to OpenDaylight/mdsal
+ namespace "urn:opendaylight:params:xml:ns:yang:external:reference";
+ prefix "extref";
+
+ organization "Cisco Systems, Inc.";
+
+ contact "Robert Varga <rovarga@cisco.com>";
+
+ description
+ "Model defining the base type for external references for use instead
+ of an instance-identifier, which does not allow referencing entities
+ unknown in the model (due to imports, etc.).
+
+ Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
+
+ This program and the accompanying materials are made available under the
+ terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ and is available at http://www.eclipse.org/legal/epl-v10.html";
+
+ revision "2016-01-29" {
+ description "Initial model";
+ }
+
+ typedef external-reference {
+ description "Reference to a YANG-modeled node which resides outside
+ of this system. The format must use module names as namespace
+ prefixes -- in a similar fashion RESTCONF does. The reference
+ is evaluated from the root of the external system.
+
+ This data type does not hold the coordinates of the external
+ system, nor does it specify which data store on the external
+ system should be used to satisfy the reference. This information
+ should be described in the model which instantiates a leaf of
+ this type.";
+ type string;
+ }
+}
diff --git a/vbd/api/src/main/yang/vbridge-topology.yang b/vbd/api/src/main/yang/vbridge-topology.yang
new file mode 100644
index 000000000..36e50aea0
--- /dev/null
+++ b/vbd/api/src/main/yang/vbridge-topology.yang
@@ -0,0 +1,159 @@
+module vbridge-topology {
+ // vi: set et smarttab sw=4 tabstop=4:
+
+ yang-version 1;
+ namespace "urn:opendaylight:params:xml:ns:yang:vbridge:topology";
+ prefix "vbridge";
+
+ organization "Cisco Systems, Inc.";
+
+ contact "Robert Varga <rovarga@cisco.com>";
+
+ description
+ "Base model describing a virtual bridge domain mapped expressed
+ as a network topology. Implementations of this model are expected
+ to map this topology onto an underlay transport/managent topology,
+ such as a NETCONF topology talking to forwarding boxes
+
+ Copyright (c) 2015 Cisco and/or its affiliates.
+
+ 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.";
+
+ revision "2016-01-29" {
+ description "Initial cut";
+ }
+
+ import ietf-inet-types { prefix "inet"; }
+ import network-topology { prefix nt; revision-date 2013-10-21; }
+ import odl-external-reference { prefix extref; }
+ import v3po { prefix "v3po"; }
+
+ identity tunnel-type {
+ description "Type of tunneling technology";
+ }
+
+ typedef tunnel-type-ref {
+ description "Reference to a tunneling technology";
+ type identityref {
+ base tunnel-type;
+ }
+ }
+
+ identity tunnel-type-vxlan {
+ // FIXME: should be in a vxlan-specific model
+ description "VXLAN tunneling";
+ base tunnel-type;
+ }
+
+ augment "/nt:network-topology/nt:topology/nt:topology-types" {
+ container vbridge-topology {
+ presence "Indicates a virtual bridge domain topology";
+ }
+ }
+
+ augment "/nt:network-topology/nt:topology" {
+ when "./nt:topology-types/vbridge-topology";
+
+ // Pointer to the NETCONF topology which supports this bridge domain
+ // FIXME: must "../../nt:underlay-topology";
+
+ leaf tunnel-type {
+ description "Tunnel technology to use for encapsulation";
+ type tunnel-type-ref;
+ }
+
+ choice tunnel-parameters {
+ container vxlan {
+ // FIXME: should be in a vxlan-specific model
+ when "../type = tunnel-type-vxlan";
+ leaf vni {
+ description "VNI to use for encap";
+ type v3po:vxlan-vni;
+ mandatory true;
+ }
+ }
+ }
+
+ uses v3po:bridge-domain-attributes;
+ }
+
+ augment "/nt:network-topology/nt:topology/nt:node" {
+ when "../nt:topology-types/vbridge-topology";
+
+ container bridge-member {
+ presence "Indicates this node is part of the bridge domain";
+
+ // Pointer to the NETCONF node which supports this bridge member
+ must "../../nt:supporting-node";
+
+ // FIXME: this is implementation specific, depends on whether
+ // the underlay has an a concept of a bridge domain.
+ leaf supporting-bridge-domain {
+ description
+ "Reference to the network element bridge domain, which has
+ been configured to support this virtual bridge domain on
+ this bridge member.
+
+ This reference needs to be resolved against the supporting
+ node's configuration data store.";
+ config false;
+ type extref:external-reference;
+ }
+ }
+ }
+
+ augment "/nt:network-topology/nt:topology/nt:node/nt:termination-point" {
+ when "../bridge-member";
+
+ choice interface-type {
+ leaf user-interface {
+ description
+ "Reference to the network element interface, which is
+ configured to be a member of this virtual bridge domain.
+
+ This reference needs to be resolved against the supporting
+ node's configuration data store.";
+ type extref:external-reference;
+ mandatory true;
+ }
+ leaf tunnel-interface {
+ description
+ "Reference to the network element interface, which is
+ configured to on the member to support exchange of packet
+ passing through this virtual bridge domain towards other
+ domain members.
+
+ This reference needs to be resolved against the supporting
+ node's configuration data store.";
+ config false;
+ type extref:external-reference;
+ mandatory true;
+ }
+ }
+ }
+
+ augment "/nt:network-topology/nt:topology/nt:link" {
+ when "../nt:topology-types/vbridge-topology";
+
+ leaf tunnel {
+ description
+ "Reference to the network element tunnel interface supporting
+ cross-connect between two bridge members.
+
+ This reference needs to be resolved against the supporting
+ node's operational data store.";
+ config false;
+ type extref:external-reference;
+ }
+ }
+}