blob: 93c965bd16ba6c38c9301f9f02d8bbdc2e21de4a [file] [log] [blame]
Marc De Leenheerf20c7fb2017-05-05 10:24:41 -07001module org-openroadm-topology {
2 namespace "http://org/openroadm/topology";
3 prefix org-openroadm-topology;
4
5 import org-openroadm-resource {
6 prefix org-openroadm-resource;
7 }
8
9 organization
10 "Open ROADM MSA";
11 contact
12 "OpenROADM.org";
13 description
14 "YANG definitions of topology.
15
16 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
17 AT&T Intellectual Property. All other rights reserved.
18
19 Redistribution and use in source and binary forms, with or without modification,
20 are permitted provided that the following conditions are met:
21
22 * Redistributions of source code must retain the above copyright notice, this
23 list of conditions and the following disclaimer.
24 * Redistributions in binary form must reproduce the above copyright notice,
25 this list of conditions and the following disclaimer in the documentation and/or
26 other materials provided with the distribution.
27 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
28 contributors may be used to endorse or promote products derived from this software
29 without specific prior written permission.
30
31 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
32 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
33 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
35 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
37 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
38 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40 POSSIBILITY OF SUCH DAMAGE";
41
42 revision 2016-10-14 {
43 description
44 "Version 1.2";
45 }
46
47 grouping topology {
48 description
49 "Topology reports the individual hops along the service in the A to Z direction and Z to A directions. This includes both ports internal to a device and those
50 at its edge that are available for externally connections. It includes both physical and logical ports.
51 Physical ports are ordered with the logical ports that run over them as follows:
52 a.\tOn ingress to a node/card, physical then logical
53 b.\tOn egress to a node/card, logical then physical";
54 list aToZ {
55 key "id";
56 leaf id {
57 description
58 "Unigue identifier for this topology component within this service";
59 type string;
60 }
61 uses hop;
62 }
63 list zToA {
64 key "id";
65 leaf id {
66 description
67 "Unigue identifier for this topology component within this service";
68 type string;
69 }
70 uses hop;
71 }
72 }
73
74 grouping hop {
75 leaf hop-type {
76 type enumeration {
77 enum "node-external" {
78 description
79 "The given resource is on the edge of the node, and used in relationships to resources outside of the node.";
80 value 1;
81 }
82 enum "node-internal" {
83 description
84 "The given resource is internally to the node";
85 value 2;
86 }
87 }
88 }
89 uses org-openroadm-resource:resource;
90 }
91}