Internet DRAFT - draft-li-rtgwg-utunnel-yang
draft-li-rtgwg-utunnel-yang
Network Working Group Z. Li
Internet-Draft X. Chen
Intended status: Standards Track Huawei Technologies
Expires: June 18, 2016 December 16, 2015
Yang Data Model for Unified Tunnel
draft-li-rtgwg-utunnel-yang-01
Abstract
This document defines a YANG data model for the unified tunnel. The
data model includes the operational state of tunnels.
Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119].
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on June 18, 2016.
Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
Li & Chen Expires June 18, 2016 [Page 1]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. 2. UTunnel Data Model Organization . . . . . . . . . . . . . 2
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . 2
3. UTunnel Yang Module . . . . . . . . . . . . . . . . . . . . . 3
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
5. Security Considerations . . . . . . . . . . . . . . . . . . . 7
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7
7. Normative References . . . . . . . . . . . . . . . . . . . . 7
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 8
1. Introduction
YANG [RFC6020] is a data definition language that was introduced to
define the contents of a conceptual data store that allows networked
devices to be managed using NETCONF[RFC6241]. YANG is proving
relevant beyond its initial confines, as bindings to other
interfaces(e.g. ReST) and encoding other than XML (e.g. JSON) are
being defined. Furthermore, YANG data models can be used as the
basis of implementation for other interface, such as CLI and
Programmatic APIs.
At present, multiple types of tunnels can be provided to carry vpn
services, such as LDP LSPs, RSVP-TE tunnel, GRE tunnel. All of the
tunnels can be managed unifiedly to support vpn services according to
tunnel policy. Different types of tunnels can be managed unifiedly
to form tunnel-group to support services.
This document defines a YANG data model for the unified tunnel. The
data model covers the operational state of tunnels.
2. 2. UTunnel Data Model Organization
2.1. Overview
The information of unified tunnel is about the generic operational
state of different types of tunnels. These core data is necessary
for vpn service to select the carrying tunnel. The tunnels include
p2p, mp2p and p2mp tunnel. P2p and mp2p tunnel use the same
container with the name p2ptunnels. P2mp tunnel is not included in
this version and will be defined later.
Li & Chen Expires June 18, 2016 [Page 2]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
Some tunnels like ldp can be from specific vrf or default vrf. And
some tunnels like rsvp-te are only from the default vrf. So the vrf-
name is as key attribute of the tunnel.
The tunnel destination can be ipv4 or ipv6 address. It depends on
implementation of the tunnel protocol.
The figure below describes the overall structure of the utunnel yang
model :
module: utunnel
+--ro utunnel
+--ro p2ptunnels
+--ro tunnel* [vrf-name tunnel-protocol tunnel-id]
+--ro vrf-name rt:routing-instance-ref
+--ro tunnel-protocol tunnel-protocol
+--ro tunnel-id tunnel-id
+--ro tunnel-name? tunnel-name
+--ro oper-status? tunnel-status
+--ro address-family
+--ro ipv4
| +--ro destination? inet:ipv4-address
+--ro ipv6
+--ro destination? inet:ipv6-address
3. UTunnel Yang Module
<CODE BEGINS> file "ietf-utunnel@2015-12-16.yang"
module ietf-utunnel {
namespace "urn:ietf:params:xml:ns:yang:ietf-utunnel";
// replace with IANA namespace when assigned
prefix "utunnel";
import ietf-inet-types {
prefix "inet";
}
import ietf-routing {
prefix "rt";
}
organization "huawei";
contact
"lizhenbin@huawei.com
xiachen@huawei.com
vinods.kumar@huawei.com";
description "unified tunnel model";
Li & Chen Expires June 18, 2016 [Page 3]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
revision "2015-12-16" {
description "2015-07-05:Initial revision"+
"2015-12-16:Add the description in the yang module.";
reference "TBD";
}
typedef tunnel-id {
type uint32;
description
"An identifier for a tunnel.";
}
typedef tunnel-name {
type string {
length "1..64";
}
description
"The name of a tunnel.";
}
typedef tunnel-protocol{
type enumeration {
enum ldp {
value "0";
description "LDP";
}
enum rsvp-te {
value "1";
description "RSVP-TE";
}
enum bgp {
value "2";
description "Labeled BGP";
}
enum cr-static-lsp {
value "3";
description "Static LSP with TE constraints";
}
enum gre {
value "4";
description "GRE";
}
enum ipsec {
value "5";
description "IPSec";
}
enum vxlan {
value "6";
Li & Chen Expires June 18, 2016 [Page 4]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
description "VXLAN";
}
enum segment-routing-best-effort {
value "7";
description "Segment Routing BE";
}
enum segment-routing-te {
value "8";
description "Segment Routing TE";
}
}
description
"The protocol which is used to set up a tunnel.";
}
typedef tunnel-status {
type enumeration {
enum up {
value "0";
description
"The status of tunnel is up.";
}
enum down {
value "1";
description
"The status of tunnel is down.";
}
}
description
"The status of a tunnel.";
}
container utunnel{
config false;
description "The information of unified tunnel. The tunnels include P2P, MP2P and P2MP tunnel.
P2P and MP2P tunnel use the same container with name P2P tunnels. P2MP tunnel is defined later.";
container p2ptunnels{
description "The information of unified P2P tunnel.";
list tunnel {
key "vrf-name tunnel-protocol tunnel-id";
description "List of unified P2P tunnels.";
leaf vrf-name {
type rt:routing-instance-ref;
description "The name of vrf. Some tunnels like LDP can be from specific VRF or default VRF.
And some tunnels like RSVP-TE are only from the default VRF.";
Li & Chen Expires June 18, 2016 [Page 5]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
}
leaf tunnel-protocol {
type tunnel-protocol;
description "The type of tunnel protocol which can be LDP, GRE, BGP etc.";
}
leaf tunnel-id {
type tunnel-id;
description "The identifier of tunnel which can be uniquely represented a tunnel with vrf-name and tunnel-protocol.";
}
leaf tunnel-name {
type tunnel-name;
description "The name of tunnel.";
}
leaf oper-status {
type tunnel-status;
description "The status of tunnel which can be up or down.";
}
container address-family {
description "IPv4 or IPv6 address family.";
container ipv4 {
description "IPv4 address family.";
leaf destination {
type inet:ipv4-address;
description "The destination is IPv4 address.";
}
} // ipv4
container ipv6 {
description "IPv6 address family.";
leaf destination {
type inet:ipv6-address;
description "The destination is ipv6 address.";
}
} // ipv6
}
}
}
}
}
<CODE ENDS>
4. IANA Considerations
This document registers the following URIs in the IETF XML registry
[RFC3688]. Following the format in [RFC3688], the following
registration is requested to be made.
Li & Chen Expires June 18, 2016 [Page 6]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
URI: urn:ietf:params:xml:ns:yang:ietf-utunnel XML: N/A, the requested
URI is an XML namespace.
This document registers a YANG module in the YANG Module Names
registry [RFC6020].
name: ietf-utunnel namespace: urn:ietf:params:xml:ns:yang:ietf-
utunnel prefix: utunnel.
5. Security Considerations
The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol[RFC6241]. The lowest NETCONF layer is the
secure transport layer and the mandatory-to-implement secure
transport is SSH [RFC6242]. The NETCONF access control model
[RFC6536] provides means to restrict access for particular NETCONF
users to a pre-configured subset of all available NETCONF protocol
operations and content. There are a number of data nodes defined in
the YANG module which are writable/creatable/deletable (i.e., config
true, which is the default). These data nodes may be considered
sensitive or vulnerable in some network environments. Write
operations (e.g., <edit-config>) to these data nodes without proper
protection can have a negative effect on network operations.
6. Acknowledgements
The authors would like to thank vinod kumar S for his contributions
to this work.
7. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<http://www.rfc-editor.org/info/rfc3688>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<http://www.rfc-editor.org/info/rfc6020>.
Li & Chen Expires June 18, 2016 [Page 7]
Internet-Draft Yang Data Model for Unified Tunnel December 2015
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<http://www.rfc-editor.org/info/rfc6242>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012,
<http://www.rfc-editor.org/info/rfc6536>.
Authors' Addresses
Zhenbin Li
Huawei Technologies
Huawei Bld., No.156 Beiqing Rd.
Beijing 100095
China
Email: lizhenbin@huawei.com
Xia Chen
Huawei Technologies
Huawei Bld., No.156 Beiqing Rd.
Beijing 100095
China
Email: jescia.chenxia@huawei.com
Li & Chen Expires June 18, 2016 [Page 8]
