--- /dev/null
+module tapi-topology {\r
+ namespace "urn:onf:otcc:yang:tapi-topology";\r
+ prefix tapi-topology;\r
+ import tapi-common {\r
+ prefix tapi-common;\r
+ }\r
+ organization "ONF OTCC (Open Transport Configuration & Control) Project";\r
+ contact "\r
+ Project Web: <https://urldefense.com/v3/__https://wiki.opennetworking.org/display/OTCC/TAPI__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_yiFzE6g$ >\r
+ Project List: <mailto:transport-api@opennetworking.org>\r
+ Editor: Karthik Sethuraman <mailto:karthik.sethuraman@necam.com>\r
+ Andrea Mazzin <mailto:andrea.mazzini@nokia.com>\r
+ Arturo Mayoral <mailto:arturo.mayoral@telefonica.com>\r
+ Nigel Davis <mailto:ndavis@ciena.com>";\r
+ description "\r
+ This module contains TAPI Topology Model definitions.\r
+ Source: TapiTopology.uml\r
+ - The TAPI YANG models included in this TAPI release are a *normative* part of the TAPI SDK.\r
+ - The YANG specifications have been generated from the corresponding UML model using the [ONF EAGLE UML2YANG mapping tool]\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/EagleUmlYang__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_6pxiNxl$ >\r
+ and further edited manually to comply with the [ONF IISOMI UML2YANG mapping guidelines]\r
+ <https://urldefense.com/v3/__https://wiki.opennetworking.org/display/OIMT/UML*-*YANG*Guidelines__;Kysr!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_wxKUbJ_$ >\r
+ - Status of YANG model artifacts can be determined by referring to the corresponding UML artifacts.\r
+ As described in the UML models, some artifacts are considered *experimental*, and thus the corresponding YANG artifacts.\r
+ - The ONF TAPI release process does not guarantee backward compatibility of YANG models across major versions of TAPI releases.\r
+ The YANG model backward compatibility criteria are outlined in section 11 of <https://urldefense.com/v3/__https://tools.ietf.org/html/rfc7950__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_zcAY1P4$ >.\r
+ YANG models included in this release may not be backward compatible with previous TAPI releases.\r
+ Copyright (c) 2018 Open Networking Foundation (ONF). All rights reserved.\r
+ License: This module is distributed under the Apache License 2.0.";\r
+ revision 2020-04-23 {\r
+ description "ONF Transport API version 2.1.3.\r
+ Changes included in this TAPI release (v2.1.3) are listed in\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop_v2_1/CHANGE_LOG/change-log.2.1.3.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_xm1nx_D$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_8UH3XnH$ >";\r
+ }\r
+ revision 2019-07-16 {\r
+ description "ONF Transport API version 2.1.2.\r
+ Changes included in this TAPI release (v2.1.2) are listed in\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop_v2_1/CHANGE_LOG/change-log.2.1.2.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_0xFu4bN$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_8UH3XnH$ >";\r
+ }\r
+ revision 2018-12-10 {\r
+ description "ONF Transport API version 2.1.1.\r
+ Changes included in this TAPI release (v2.1.1) are listed in\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.1.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur__2p0od1$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_8UH3XnH$ >";\r
+ }\r
+ revision 2018-10-16 {\r
+ description "ONF Transport API version 2.1.0.\r
+ Changes included in this TAPI release (v2.1.0) are listed in\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.1.0.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_4DGi8ul$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 7950, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.1.0/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_8UH3XnH$ >";\r
+ }\r
+ revision 2018-03-07 {\r
+ description "ONF Transport API version 2.0.2\r
+ This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.\r
+ Changes in this revision: <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.2.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_8KlxwJZ$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.2/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_-hMD5Xl$ >";\r
+ }\r
+ revision 2018-02-16 {\r
+ description "ONF Transport API version 2.0.1\r
+ This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.\r
+ Changes in this revision: <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.1.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur__C1vuym$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.1/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_5DYNwzZ$ >";\r
+ }\r
+ revision 2018-01-02 {\r
+ description "ONF Transport API version 2.0.0\r
+ This YANG module has been generated from the TAPI UML Model using the IISOMI-Eagle xmi2yang mapping tool.\r
+ Changes in this revision: <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/blob/develop/CHANGE_LOG/change-log.2.0.0.md__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_1xZSBRA$ >";\r
+ reference "ONF-TR-527, ONF-TR-512, ONF-TR-531, RFC 6020, RFC 6087 and ONF TAPI UML model\r
+ <https://urldefense.com/v3/__https://github.com/OpenNetworkingFoundation/TAPI/tree/v2.0.0/UML__;!!OSsGDw!bx-l35NqfQHpJ8R_DmXfi2NX2ll5dMl9VbK5aS_m3ZShiVoz74Ur_xt-GtqY$ >";\r
+ }\r
+ augment "/tapi-common:context" {\r
+ container topology-context {\r
+ uses topology-context;\r
+ description "Augments the base TAPI Context with TopologyService information";\r
+ }\r
+ description "Augments the base TAPI Context with TopologyService information";\r
+ }\r
+\r
+ /**************************\r
+ * definitions of refrences\r
+ **************************/\r
+ grouping topology-ref {\r
+ leaf topology-uuid {\r
+ type leafref {\r
+ path '/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:uuid';\r
+ }\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+ grouping link-ref {\r
+ uses topology-ref;\r
+ leaf link-uuid {\r
+ type leafref {\r
+ path '/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:link/tapi-topology:uuid';\r
+ }\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+ grouping node-ref {\r
+ uses topology-ref;\r
+ leaf node-uuid {\r
+ type leafref {\r
+ path '/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:uuid';\r
+ }\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+ grouping node-edge-point-ref {\r
+ uses node-ref;\r
+ leaf node-edge-point-uuid {\r
+ type leafref {\r
+ path '/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:owned-node-edge-point/tapi-topology:uuid';\r
+ }\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+ grouping node-rule-group-ref {\r
+ uses node-ref;\r
+ leaf node-rule-group-uuid {\r
+ type leafref {\r
+ path '/tapi-common:context/tapi-topology:topology-context/tapi-topology:topology/tapi-topology:node/tapi-topology:node-rule-group/tapi-topology:uuid';\r
+ }\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+\r
+ /**************************\r
+ * package object-classes\r
+ **************************/ \r
+ grouping link {\r
+ list node-edge-point {\r
+ uses node-edge-point-ref;\r
+ key 'topology-uuid node-uuid node-edge-point-uuid';\r
+ config false;\r
+ min-elements 2;\r
+ description "none";\r
+ }\r
+ leaf-list layer-protocol-name {\r
+ type tapi-common:layer-protocol-name;\r
+ config false;\r
+ min-elements 1;\r
+ description "none";\r
+ }\r
+ leaf direction {\r
+ type tapi-common:forwarding-direction;\r
+ config false;\r
+ description "The directionality of the Link.\r
+ Is applicable to simple Links where all LinkEnds are BIDIRECTIONAL (the Link will be BIDIRECTIONAL) or UNIDIRECTIONAL (the Link will be UNIDIRECTIONAL).\r
+ Is not present in more complex cases.";\r
+ }\r
+ container resilience-type {\r
+ uses resilience-type;\r
+ description "none";\r
+ }\r
+ uses tapi-common:resource-spec;\r
+ uses tapi-common:admin-state-pac;\r
+ uses tapi-common:capacity-pac;\r
+ uses transfer-cost-pac;\r
+ uses transfer-integrity-pac;\r
+ uses transfer-timing-pac;\r
+ uses risk-parameter-pac;\r
+ uses validation-pac;\r
+ uses layer-protocol-transition-pac;\r
+ description "The Link object class models effective adjacency between two or more ForwardingDomains (FD). ";\r
+ }\r
+ grouping node {\r
+ list owned-node-edge-point {\r
+ key 'uuid';\r
+ config false;\r
+ uses node-edge-point;\r
+ description "none";\r
+ }\r
+ list aggregated-node-edge-point {\r
+ uses node-edge-point-ref;\r
+ key 'topology-uuid node-uuid node-edge-point-uuid';\r
+ config false;\r
+ description "none";\r
+ }\r
+ list node-rule-group {\r
+ key 'uuid';\r
+ uses node-rule-group;\r
+ description "none";\r
+ }\r
+ container encap-topology {\r
+ uses topology-ref;\r
+ config false;\r
+ description "none";\r
+ }\r
+ leaf-list layer-protocol-name {\r
+ type tapi-common:layer-protocol-name;\r
+ config false;\r
+ min-elements 1;\r
+ description "none";\r
+ }\r
+ uses tapi-common:resource-spec;\r
+ uses tapi-common:admin-state-pac;\r
+ uses tapi-common:capacity-pac;\r
+ uses transfer-cost-pac;\r
+ uses transfer-integrity-pac;\r
+ uses transfer-timing-pac;\r
+ description "The ForwardingDomain (FD) object class models the ForwardingDomain topological component which is used to effect forwarding of transport characteristic information and offers the potential to enable forwarding.\r
+ At the lowest level of recursion, an FD (within a network element (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass multiple switch matrices (FDs). ";\r
+ }\r
+ grouping topology {\r
+ list node {\r
+ key 'uuid';\r
+ config false;\r
+ uses node;\r
+ description "none";\r
+ }\r
+ list link {\r
+ key 'uuid';\r
+ config false;\r
+ uses link;\r
+ description "none";\r
+ }\r
+ leaf-list layer-protocol-name {\r
+ type tapi-common:layer-protocol-name;\r
+ config false;\r
+ min-elements 1;\r
+ description "none";\r
+ }\r
+ uses tapi-common:resource-spec;\r
+ description "The ForwardingDomain (FD) object class models the ForwardingDomain topological component which is used to effect forwarding of transport characteristic information and offers the potential to enable forwarding. \r
+ At the lowest level of recursion, an FD (within a network element (NE)) represents a switch matrix (i.e., a fabric). Note that an NE can encompass multiple switch matrices (FDs). ";\r
+ }\r
+ grouping layer-protocol-transition-pac {\r
+ leaf-list transitioned-layer-protocol-name {\r
+ type string;\r
+ min-elements 2;\r
+ description "Provides the ordered structure of layer protocol transitions encapsulated in the TopologicalEntity. The ordering relates to the LinkPort role.";\r
+ }\r
+ description "Relevant for a Link that is formed by abstracting one or more LTPs (in a stack) to focus on the flow and deemphasize the protocol transformation.\r
+ This abstraction is relevant when considering multi-layer routing.\r
+ The layer protocols of the LTP and the order of their application to the signal is still relevant and need to be accounted for. This is derived from the LTP spec details.\r
+ This Pac provides the relevant abstractions of the LTPs and provides the necessary association to the LTPs involved.\r
+ Links that included details in this Pac are often referred to as Transitional Links.";\r
+ }\r
+ grouping node-edge-point {\r
+ leaf layer-protocol-name {\r
+ type tapi-common:layer-protocol-name;\r
+ config false;\r
+ description "none";\r
+ }\r
+ leaf-list supported-cep-layer-protocol-qualifier {\r
+ type tapi-common:layer-protocol-qualifier;\r
+ min-elements 1;\r
+ description "none";\r
+ }\r
+ list aggregated-node-edge-point {\r
+ uses node-edge-point-ref;\r
+ key 'topology-uuid node-uuid node-edge-point-uuid';\r
+ config false;\r
+ description "none";\r
+ }\r
+ list mapped-service-interface-point {\r
+ uses tapi-common:service-interface-point-ref;\r
+ key 'service-interface-point-uuid';\r
+ config false;\r
+ description "NodeEdgePoint mapped to more than ServiceInterfacePoint (slicing/virtualizing) or a ServiceInterfacePoint mapped to more than one NodeEdgePoint (load balancing/Resilience) should be considered experimental";\r
+ }\r
+ leaf link-port-direction {\r
+ type tapi-common:port-direction;\r
+ config false;\r
+ description "The orientation of defined flow at the LinkEnd.";\r
+ }\r
+ leaf link-port-role {\r
+ type tapi-common:port-role;\r
+ config false;\r
+ description "Each LinkEnd of the Link has a role (e.g., symmetric, hub, spoke, leaf, root) in the context of the Link with respect to the Link function. ";\r
+ }\r
+ uses tapi-common:resource-spec;\r
+ uses tapi-common:admin-state-pac;\r
+ uses tapi-common:termination-pac;\r
+ uses tapi-common:capacity-pac;\r
+ description "The LogicalTerminationPoint (LTP) object class encapsulates the termination and adaptation functions of one or more transport layers.\r
+ The structure of LTP supports all transport protocols including circuit and packet forms.";\r
+ }\r
+ grouping risk-parameter-pac {\r
+ list risk-characteristic {\r
+ key 'risk-characteristic-name';\r
+ config false;\r
+ min-elements 1;\r
+ uses risk-characteristic;\r
+ description "A list of risk characteristics for consideration in an analysis of shared risk. Each element of the list represents a specific risk consideration.";\r
+ }\r
+ description "The risk characteristics of a TopologicalEntity come directly from the underlying physical realization.\r
+ The risk characteristics propagate from the physical realization to the client and from the server layer to the client layer, this propagation may be modified by protection.\r
+ A TopologicalEntity may suffer degradation or failure as a result of a problem in a part of the underlying realization.\r
+ The realization can be partitioned into segments which have some relevant common failure modes.\r
+ There is a risk of failure/degradation of each segment of the underlying realization.\r
+ Each segment is a part of a larger physical/geographical unit that behaves as one with respect to failure (i.e. a failure will have a high probability of impacting the whole unit (e.g. all cables in the same duct).\r
+ Disruptions to that larger physical/geographical unit will impact (cause failure/errors to) all TopologicalEntities that use any part of that larger physical/geographical entity.\r
+ Any TopologicalEntity that uses any part of that larger physical/geographical unit will suffer impact and hence each TopologicalEntity shares risk.\r
+ The identifier of each physical/geographical unit that is involved in the realization of each segment of a Topological entity can be listed in the RiskParameter_Pac of that TopologicalEntity.\r
+ A segment has one or more risk characteristic.\r
+ Shared risk between two TopologicalEntities compromises the integrity of any solution that use one of those TopologicalEntity as a backup for the other.\r
+ Where two TopologicalEntities have a common risk characteristic they have an elevated probability of failing simultaneously compared to two TopologicalEntities that do not share risk characteristics.";\r
+ }\r
+ grouping transfer-cost-pac {\r
+ list cost-characteristic {\r
+ key 'cost-name';\r
+ config false;\r
+ min-elements 1;\r
+ uses cost-characteristic;\r
+ description "The list of costs where each cost relates to some aspect of the TopologicalEntity.";\r
+ }\r
+ description "The cost characteristics of a TopologicalEntity not necessarily correlated to the cost of the underlying physical realization.\r
+ They may be quite specific to the individual TopologicalEntity e.g. opportunity cost. Relates to layer capacity.\r
+ There may be many perspectives from which cost may be considered for a particular TopologicalEntity and hence many specific costs and potentially cost algorithms.\r
+ Using an entity will incur a cost. ";\r
+ }\r
+ grouping transfer-integrity-pac {\r
+ leaf error-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Describes the degree to which the signal propagated can be errored.\r
+ Applies to TDM systems as the errored signal will be propagated and not packet as errored packets will be discarded.";\r
+ }\r
+ leaf loss-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Describes the acceptable characteristic of lost packets where loss may result from discard due to errors or overflow.\r
+ Applies to packet systems and not TDM (as for TDM errored signals are propagated unless grossly errored and overflow/underflow turns into timing slips).";\r
+ }\r
+ leaf repeat-delivery-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Primarily applies to packet systems where a packet may be delivered more than once (in fault recovery for example).\r
+ It can also apply to TDM where several frames may be received twice due to switching in a system with a large differential propagation delay.";\r
+ }\r
+ leaf delivery-order-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Describes the degree to which packets will be delivered out of sequence.\r
+ Does not apply to TDM as the TDM protocols maintain strict order.";\r
+ }\r
+ leaf unavailable-time-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Describes the duration for which there may be no valid signal propagated.";\r
+ }\r
+ leaf server-integrity-process-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Describes the effect of any server integrity enhancement process on the characteristics of the TopologicalEntity.";\r
+ }\r
+ description "Transfer intergrity characteristic covers expected/specified/acceptable characteristic of degradation of the transfered signal.\r
+ It includes all aspects of possible degradation of signal content as well as any damage of any form to the total TopologicalEntity and to the carried signals.\r
+ Note that the statement is of total impact to the TopologicalEntity so any partial usage of the TopologicalEntity (e.g. a signal that does not use full capacity) will only suffer its portion of the impact.";\r
+ }\r
+ grouping transfer-timing-pac {\r
+ list latency-characteristic {\r
+ key 'traffic-property-name';\r
+ config false;\r
+ min-elements 1;\r
+ uses latency-characteristic;\r
+ description "The effect on the latency of a queuing process. This only has significant effect for packet based systems and has a complex characteristic.";\r
+ }\r
+ description "A TopologicalEntity will suffer effects from the underlying physical realization related to the timing of the information passed by the TopologicalEntity.";\r
+ }\r
+ grouping validation-pac {\r
+ list validation-mechanism {\r
+ key 'validation-mechanism';\r
+ config false;\r
+ min-elements 1;\r
+ uses validation-mechanism;\r
+ description "Provides details of the specific validation mechanism(s) used to confirm the presence of an intended topologicalEntity.";\r
+ }\r
+ description "Validation covers the various adjacenct discovery and reachability verification protocols. Also may cover Information source and degree of integrity.";\r
+ }\r
+ grouping network-topology-service {\r
+ list topology {\r
+ uses topology-ref;\r
+ key 'topology-uuid';\r
+ config false;\r
+ description "none";\r
+ }\r
+ uses tapi-common:service-spec;\r
+ description "none";\r
+ }\r
+ grouping topology-context {\r
+ container nw-topology-service {\r
+ config false;\r
+ uses network-topology-service;\r
+ description "none";\r
+ }\r
+ list topology {\r
+ key 'uuid';\r
+ config false;\r
+ uses topology;\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+ grouping inter-rule-group {\r
+ list rule {\r
+ key 'local-id';\r
+ config false;\r
+ min-elements 1;\r
+ uses rule;\r
+ description "The list of rules of the InterRuleGroup.";\r
+ }\r
+ list associated-node-rule-group {\r
+ uses node-rule-group-ref;\r
+ key 'topology-uuid node-uuid node-rule-group-uuid';\r
+ config false;\r
+ min-elements 2;\r
+ description "The NodeRuleGroups that the InterRuleGroup constrains interconnection between.\r
+ The CEPs of the NEPs of a referenced NodeRuleGroup can interconnect to the CEPs of the NEPs of another referenced NodeRuleGroup constrained by the rules of the InterRuleGroup.";\r
+ }\r
+ uses tapi-common:resource-spec;\r
+ uses tapi-common:capacity-pac;\r
+ uses transfer-cost-pac;\r
+ uses transfer-timing-pac;\r
+ uses risk-parameter-pac;\r
+ description "Rules that apply between groups of NEPs.";\r
+ }\r
+ grouping node-rule-group {\r
+ list rule {\r
+ key 'local-id';\r
+ config false;\r
+ min-elements 1;\r
+ uses rule;\r
+ description "The list of rules of the NodeRuleGroup.";\r
+ }\r
+ list node-edge-point {\r
+ uses node-edge-point-ref;\r
+ key 'topology-uuid node-uuid node-edge-point-uuid';\r
+ config false;\r
+ min-elements 1;\r
+ description "NEPs and their client CEPs that the rules apply to.";\r
+ }\r
+ list node-rule-group {\r
+ uses node-rule-group-ref;\r
+ key 'topology-uuid node-uuid node-rule-group-uuid';\r
+ config false;\r
+ description "NodeRuleGroups may be nested such that finer grained rules may be applied.\r
+ A nested rule group should have a subset of the NEPs of the superior rule group.";\r
+ }\r
+ list inter-rule-group {\r
+ key 'uuid';\r
+ uses inter-rule-group;\r
+ config false;\r
+ description "Nested NodeRuleGroups may have InterRuleGroups. The Superior NodeRuleGroup contains the nested NodeRuleGroups and their associated InterRuleGroups.\r
+ This is equivalent to the Node-Topology hierarchy.";\r
+ }\r
+ uses tapi-common:resource-spec;\r
+ uses tapi-common:capacity-pac;\r
+ uses transfer-cost-pac;\r
+ uses transfer-timing-pac;\r
+ uses risk-parameter-pac;\r
+ description "Rules that apply to a group of NEPs.\r
+ ";\r
+ }\r
+ grouping rule {\r
+ leaf rule-type {\r
+ type rule-type;\r
+ config false;\r
+ description "The focus of the rule.";\r
+ }\r
+ leaf forwarding-rule {\r
+ type forwarding-rule;\r
+ config false;\r
+ description "Rule that restricts the creation/deletion of a Connection between points in the node rule group or related by the inter rule group between node rule groups.";\r
+ }\r
+ leaf override-priority {\r
+ type uint64;\r
+ config false;\r
+ description "The overridePriority allows for one rule in a rule group to override another.\r
+ Priority n rules override priority n+1 rules.\r
+ Rules of the same priority override as follows (n overrides n+1):\r
+ 1 - MustNot\r
+ 2 - Must\r
+ 3 - May\r
+ 4 - Null\r
+ Within a rule the flexibility rules (signal, port role...) override as follows (n overriedes n+1):\r
+ 1 - Any\r
+ 2 - Same\r
+ 3 - Different\r
+ Where there are two or more 'Same' rules, they will form an intersection where all must be met.\r
+ ";\r
+ }\r
+ leaf-list cep-direction {\r
+ type tapi-common:port-direction;\r
+ config false;\r
+ description "cep direction is a list of port directions that the rule applies to.\r
+ No entry means all cep directions.";\r
+ }\r
+ list cep-port-role {\r
+ uses port-role-rule;\r
+ config false;\r
+ description "Indicates the port role to which the rule applies. \r
+ The port role is interpreted in the context of the connection type which is identified by the connection spec. \r
+ The port role is not meaningful in the absence of a connection spec reference.\r
+ If a node rule group carries a port role, that role applies also to the associated inter rule where the combination of the roles in the node rule groups at the ends of the inter group rule define the connection orientation.\r
+ For example a root-and-leaf connection may be used in a node where a node rule group collects one set of NEPs has the port role 'root' and another node rule group collects another set of NEPs has the port role 'leaf' where these are joined by an inter rule group. This combination specifies an allowed orientation of the root-and-leaf connection.\r
+ No port role statement means all port roles are allowed.";\r
+ }\r
+ list connection-spec-reference {\r
+ config false;\r
+ uses connection-spec-reference;\r
+ description "Identifies the type of connection that the rule applies to. \r
+ If the attribute is not present then the rule applies to all types of connection supported by the device.";\r
+ }\r
+ leaf-list layer-protocol-qualifier {\r
+ type tapi-common:layer-protocol-qualifier;\r
+ config false;\r
+ description "Qualifies a rule for a particular layerProtocol identifying the qualifiers that the rule apples to.\r
+ If the attribute is not present then the rule applies to all relevant qualifiers of the layer protocol of the parent entity.";\r
+ }\r
+ container signal-property {\r
+ config false;\r
+ uses signal-property-rule;\r
+ description "The rule only applies to signals with the properties listed. \r
+ If the attribute is not present then the rule applies to all signals.";\r
+ }\r
+ leaf-list complex-rule {\r
+ type string;\r
+ config false;\r
+ description "Allows for more complex rules where the basic rule system is not sufficient.";\r
+ }\r
+ uses tapi-common:local-class;\r
+ description "Single complex rule statememt.\r
+ A Node with no rule group has no restrictions and is essentially May/Any\r
+ A node rule group constrain the CEP connectability in the Node.\r
+ A connection from a NEP must abide by all rules that relate to that NEP\r
+ Rules that are for a particular layerProtocolQualifier, connectionSpecReference, cepPortRole and cepDirection combination must be abided by in combination as dictated by overridePriority.\r
+ If a particular\r
+ - connectionSpecReference does not have any rule statements then it is not supported and connections of that type are not possible within the rule group.\r
+ - cepPortRole of a particular connectionSpecReference does not have any rule statements then it is not supported and connections of that connectionSpecReference (type) cannot have that cepPortRole for CEPs from NEPs in that rule group.\r
+ - cepDirection for a particular connectionSpecReference does not have any rule statements then it is not supported and connections of that connectionSpecReference (type) cannot have that cepPortDirection for CEPs from NEPs in that rule group.\r
+ Rules that are for different layerProtocolQualifiers or connectionSpecReferences are independent and provide options for connection in the rule group.\r
+ Some rules may apply to multiple connectionSpecReferences and all cepPortRoles and all cepDirections.";\r
+ }\r
+\r
+ /**************************\r
+ * package type-definitions\r
+ **************************/ \r
+ identity PORT_ROLE_RULE_OPTION {\r
+ description "none";\r
+ }\r
+ identity PORT_ROLE_RULE_OPTION_SAME_ROLE {\r
+ base PORT_ROLE_RULE_OPTION;\r
+ description "The ports of the connection to which the rule applies must have the same role from the list in port role.";\r
+ }\r
+ identity PORT_ROLE_RULE_OPTION_DIFFERENT_ROLE {\r
+ base PORT_ROLE_RULE_OPTION;\r
+ description "The ports of the connection to which the rule applies must have different roles from the list in port role.";\r
+ }\r
+ identity PORT_ROLE_RULE_OPTION_ANY_ROLE {\r
+ base PORT_ROLE_RULE_OPTION;\r
+ description "The ports of the connection to which the rule applies may take any identified role.";\r
+ }\r
+ identity PORT_ROLE_RULE_OPTION_NOT_ROLE {\r
+ base PORT_ROLE_RULE_OPTION;\r
+ description "The ports of the connection to which the rule applies must not have any of the listed roles.";\r
+ }\r
+ identity SIGNAL_PROPERTY_VALUE_RULE {\r
+ description "none";\r
+ }\r
+ identity SIGNAL_PROPERTY_VALUE_RULE_SAME_VALUE {\r
+ base SIGNAL_PROPERTY_VALUE_RULE;\r
+ description "The signal property of the cep to which the rule applies must have the same value from the identied list.";\r
+ }\r
+ identity SIGNAL_PROPERTY_VALUE_RULE_ANY_VALUE {\r
+ base SIGNAL_PROPERTY_VALUE_RULE;\r
+ description "The signal property of the cep to which the rule applies may take any identified value.";\r
+ }\r
+ identity SIGNAL_PROPERTY_VALUE_RULE_DIFFERENT_VALUE {\r
+ base SIGNAL_PROPERTY_VALUE_RULE;\r
+ description "The signal property of the cep to which the rule applies each must have different values from the identified list.";\r
+ }\r
+ identity SIGNAL_PROPERTY_VALUE_RULE_NOT_VALUE {\r
+ base SIGNAL_PROPERTY_VALUE_RULE;\r
+ description "The signal property of the cep to which the rule applies must not have any of the identified values.";\r
+ }\r
+ grouping cost-characteristic {\r
+ leaf cost-name {\r
+ type string;\r
+ description "The cost characteristic will related to some aspect of the TopologicalEntity (e.g. $ cost, routing weight). This aspect will be conveyed by the costName.";\r
+ }\r
+ leaf cost-value {\r
+ type string;\r
+ description "The specific cost.";\r
+ }\r
+ leaf cost-algorithm {\r
+ type string;\r
+ description "The cost may vary based upon some properties of the TopologicalEntity. The rules for the variation are conveyed by the costAlgorithm.";\r
+ }\r
+ description "The information for a particular cost characteristic.";\r
+ }\r
+ grouping latency-characteristic {\r
+ leaf traffic-property-name {\r
+ type string;\r
+ description "The identifier of the specific traffic property to which the queuing latency applies.";\r
+ }\r
+ leaf fixed-latency-characteristic {\r
+ type string;\r
+ config false;\r
+ description "A TopologicalEntity suffers delay caused by the realization of the servers (e.g. distance related; FEC encoding etc.) along with some client specific processing. This is the total average latency effect of the TopologicalEntity";\r
+ }\r
+ leaf queing-latency-characteristic {\r
+ type string;\r
+ description "The specific queuing latency for the traffic property.";\r
+ }\r
+ leaf jitter-characteristic {\r
+ type string;\r
+ config false;\r
+ description "High frequency deviation from true periodicity of a signal and therefore a small high rate of change of transfer latency.\r
+ Applies to TDM systems (and not packet).";\r
+ }\r
+ leaf wander-characteristic {\r
+ type string;\r
+ config false;\r
+ description "Low frequency deviation from true periodicity of a signal and therefore a small low rate of change of transfer latency.\r
+ Applies to TDM systems (and not packet).";\r
+ }\r
+ description "Provides information on latency characteristic for a particular stated trafficProperty.";\r
+ }\r
+ grouping risk-characteristic {\r
+ leaf risk-characteristic-name {\r
+ type string;\r
+ description "The name of the risk characteristic. The characteristic may be related to a specific degree of closeness.\r
+ For example a particular characteristic may apply to failures that are localized (e.g. to one side of a road) where as another characteristic may relate to failures that have a broader impact (e.g. both sides of a road that crosses a bridge).\r
+ Depending upon the importance of the traffic being routed different risk characteristics will be evaluated.";\r
+ }\r
+ leaf-list risk-identifier-list {\r
+ type string;\r
+ min-elements 1;\r
+ description "A list of the identifiers of each physical/geographic unit (with the specific risk characteristic) that is related to a segment of the TopologicalEntity.";\r
+ }\r
+ description "The information for a particular risk characteristic where there is a list of risk identifiers related to that characteristic.";\r
+ }\r
+ grouping validation-mechanism {\r
+ leaf validation-mechanism {\r
+ type string;\r
+ description "Name of mechanism used to validate adjacency";\r
+ }\r
+ leaf layer-protocol-adjacency-validated {\r
+ type string;\r
+ description "State of validatiion";\r
+ }\r
+ leaf validation-robustness {\r
+ type string;\r
+ description "Quality of validation (i.e. how likely is the stated validation to be invalid)";\r
+ }\r
+ description "Identifies the validation mechanism and describes the characteristics of that mechanism";\r
+ }\r
+ typedef forwarding-rule {\r
+ type enumeration {\r
+ enum MAY_FORWARD_ACROSS_GROUP {\r
+ description "NEPs referenced by the node rule group (or indirectly by the inter rule group between node rule groups) may have connections created between them unless some other rule overrides this.\r
+ For an inter rule group points in a node rule group at one end of the inter rule group may be connected to points in an node rule group at an other end of the inter rule group.";\r
+ }\r
+ enum MUST_FORWARD_ACROSS_GROUP {\r
+ description "NEPs referenced by the node rule group (or indirectly by the inter rule group between node rule groups) MUST have connections created between them unless some other rule overrides this.\r
+ For an inter rule group points in a node rule group at one end of the inter rule group MUST be connected to points in an node rule group at an other end of the inter rule group.";\r
+ }\r
+ enum CANNOT_FORWARD_ACROSS_GROUP {\r
+ description "NEPs referenced by the node rule group (or indirectly by the inter rule group between node rule groups) MUST NOT have connections created between them.\r
+ For an inter rule group points in a node rule group at one end of the inter rule group MUST NOT be connected to points in an node rule group at an other end of the inter rule group.";\r
+ }\r
+ enum NO_STATEMENT_ON_FORWARDING {\r
+ description "The rule group makes no statement on forwarding.";\r
+ }\r
+ enum INTER_CONNECTION_CONTENTION {\r
+ description "Connections to NEPs in the rule group contend for resources based upon a constraint of some signal property.\r
+ For example, each connection to a NEP in the group must use a different value of the signal property from all other connections to NEPs in the rule group.\r
+ For example, each connection to a NEP in the group must use a same value of the signal property as all other connections to NEPs in the rule group. In this case the first connection created in the rule group sets the value and the group constraint is freed when the last connection is deleted.";\r
+ }\r
+ }\r
+ description "Rule that restricts the creation/deletion of an connection between points referenced by rule groups.";\r
+ }\r
+ typedef rule-type {\r
+ type enumeration {\r
+ enum FORWARDING {\r
+ description "The rule applies to the creation of connections.";\r
+ }\r
+ enum CAPACITY {\r
+ description "The rule applies to capacity limitations.";\r
+ }\r
+ enum COST {\r
+ description "The rule applies to the cost of the creation of connections.";\r
+ }\r
+ enum TIMING {\r
+ description "The rule applies to timing constraints across the group.";\r
+ }\r
+ enum RISK {\r
+ description "The rule applies to risk considerations across the group so as to express shared risk.";\r
+ }\r
+ enum GROUPING {\r
+ description "The rule is simply for grouping related to other rules.";\r
+ }\r
+ }\r
+ description "The focus of the rule.";\r
+ }\r
+ grouping resilience-type {\r
+ leaf restoration-policy {\r
+ type restoration-policy;\r
+ description "none";\r
+ }\r
+ leaf protection-type {\r
+ type protection-type;\r
+ description "none";\r
+ }\r
+ description "none";\r
+ }\r
+ typedef restoration-policy {\r
+ type enumeration {\r
+ enum PER_DOMAIN_RESTORATION {\r
+ description "none";\r
+ }\r
+ enum END_TO_END_RESTORATION {\r
+ description "none";\r
+ }\r
+ enum NA {\r
+ description "none";\r
+ }\r
+ }\r
+ description "none";\r
+ }\r
+ typedef protection-type {\r
+ type enumeration {\r
+ enum NO_PROTECTON {\r
+ description "none";\r
+ }\r
+ enum ONE_PLUS_ONE_PROTECTION {\r
+ description "none";\r
+ }\r
+ enum ONE_PLUS_ONE_PROTECTION_WITH_DYNAMIC_RESTORATION {\r
+ description "none";\r
+ }\r
+ enum PERMANENT_ONE_PLUS_ONE_PROTECTION {\r
+ description "none";\r
+ }\r
+ enum ONE_FOR_ONE_PROTECTION {\r
+ description "none";\r
+ }\r
+ enum DYNAMIC_RESTORATION {\r
+ description "none";\r
+ }\r
+ enum PRE_COMPUTED_RESTORATION {\r
+ description "none";\r
+ }\r
+ enum ONE_PLUS_ONE_PROTECTION_WITH_PRE_COMPUTED_RESTORATION {\r
+ description "none";\r
+ }\r
+ }\r
+ description "none";\r
+ }\r
+ grouping connection-spec-reference {\r
+ leaf connection-spec-name {\r
+ type string;\r
+ config false;\r
+ description "The name of the connection type spec.\r
+ This can be used as a reference to a paper document where full formal machine interpretable specs are not supported.";\r
+ }\r
+ leaf connection-spec-id {\r
+ type tapi-common:uuid;\r
+ config false;\r
+ description "The reference to a formal spec. \r
+ This reference need not be provided (e.g., where there is no formal machine interpretable spec for the type of connection).";\r
+ }\r
+ description "The definition of the type of connection.\r
+ This definition will explain the flows in the connections and how they relate to the port roles.";\r
+ }\r
+ typedef port-role {\r
+ type string;\r
+ description "The role of a port in the context of the connection spec referenced in the rule.";\r
+ }\r
+ grouping port-role-rule {\r
+ leaf-list port-role {\r
+ type port-role;\r
+ config false;\r
+ description "The role(s) of the port(s) considered in the rule.";\r
+ }\r
+ leaf-list port-role-rule {\r
+ type port-role-rule-option;\r
+ config false;\r
+ description "Where the rule references more than one port role or where there are rule intersections either as a result of overlay of rules or inter rule group usage indicates role matching criteria for a connection following the rules.\r
+ For example if two port roles, 'a' and 'b', are listed and the port role rule is 'different', this means that a connection connecting points in that group must have port roles that are different for each CEP in that group.\r
+ In the example if a connection can have n ports of role 'a' and m ports of role 'b' then a maximum of two ports can be drawn from the NEPs of the group and where there are two, one must be role 'a' and one must be role 'b'.";\r
+ }\r
+ description "Constrains which port roles the rule applies to.";\r
+ }\r
+ typedef port-role-rule-option {\r
+ type identityref {\r
+ base PORT_ROLE_RULE_OPTION;\r
+ }\r
+ description "Indicates how to interpret the port role list.";\r
+ }\r
+ grouping signal-property-rule {\r
+ leaf signal-property-name {\r
+ type string;\r
+ config false;\r
+ description "The name of the signal property to which the rule applies.";\r
+ }\r
+ leaf signal-property-value-rule {\r
+ type signal-property-value-rule;\r
+ config false;\r
+ description "Indicates how the signal properties should be accounted for.";\r
+ }\r
+ leaf-list applicable-signal-value {\r
+ type string;\r
+ config false;\r
+ description "Specific values of the signal property to which the rule applies.";\r
+ }\r
+ leaf number-of-signal-values {\r
+ type uint64;\r
+ config false;\r
+ description "The number of instances of this specific property that can be supported by the group.";\r
+ }\r
+ description "Rule related to an identified signal property.";\r
+ }\r
+ typedef signal-property-value-rule {\r
+ type identityref {\r
+ base SIGNAL_PROPERTY_VALUE_RULE;\r
+ }\r
+ description "Indicates how to interpret the signal property value rule.";\r
+ }\r
+\r
+ /**************************\r
+ * package interfaces\r
+ **************************/ \r
+ rpc get-topology-details {\r
+ description "none";\r
+ input {\r
+ leaf topology-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ }\r
+ output {\r
+ container topology {\r
+ uses topology;\r
+ description "none";\r
+ }\r
+ }\r
+ }\r
+ rpc get-node-details {\r
+ description "none";\r
+ input {\r
+ leaf topology-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ leaf node-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ }\r
+ output {\r
+ container node {\r
+ uses node;\r
+ description "none";\r
+ }\r
+ }\r
+ }\r
+ rpc get-node-edge-point-details {\r
+ description "none";\r
+ input {\r
+ leaf topology-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ leaf node-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ leaf ep-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ }\r
+ output {\r
+ container node-edge-point {\r
+ uses node-edge-point;\r
+ description "none";\r
+ }\r
+ }\r
+ }\r
+ rpc get-link-details {\r
+ description "none";\r
+ input {\r
+ leaf topology-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ leaf link-id-or-name {\r
+ type string;\r
+ description "none";\r
+ }\r
+ }\r
+ output {\r
+ container link {\r
+ uses link;\r
+ description "none";\r
+ }\r
+ }\r
+ }\r
+ rpc get-topology-list {\r
+ description "none";\r
+ output {\r
+ list topology {\r
+ key 'uuid';\r
+ uses topology;\r
+ description "none";\r
+ }\r
+ }\r
+ }\r
+\r
+}\r
Code Review / sim / o1-interface.git / blobdiff