Internet DRAFT - draft-han-netmod-intf-ext-ppp-yang
draft-han-netmod-intf-ext-ppp-yang
Internet Engineering Task Force Hansance Han
Internet Draft Ericsson
Intended status: Standards Track Xianghua Gu
Ericsson
Hua Lv
Ericsson
James Zhang
Ericsson
Expires: August 2017 February 27,
20177
Yang Data Model for PPP Protocol
draft-han-netmod-intf-ext-ppp-yang-02.txt
Abstract
This document defines a YANG data model that can be used to
configure and manage PPP.
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), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
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."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html
This Internet-Draft will expire on May 27, 2009.
Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 1]
Internet-Draft PPP Yang Data Model February 2017
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
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
1.1. Terminology...............................................2
1.2. Tree Diagrams.............................................3
2. Design of Data Model...........................................3
2.1. Overview..................................................3
3. PPP YANG Module................................................4
4. Security Considerations........................................7
5. IANA Considerations............................................7
6. Normative References...........................................7
7. Appendix A. Change Log........................................7
1. Introduction
This document defines a YANG [RFC6020] data model for the management
of PPP protocol.
This data model includes configuration data and state data (status
information and counters for the collection of statistics).
1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119].
The following terms are used within this document:
The following terms are defined in [RFC6241] and are not redefined
here:
o client
o configuration data
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 2]
Internet-Draft PPP Yang Data Model February 2017
o server
o state data
The following terms are defined in [RFC6020] and are not redefined
here:
o augment
o data model
o data node
o presence container
1.2. Tree Diagrams
A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these diagrams is as
follows:
o Brackets "[" and "]" enclose list keys.
o Abbreviations before data node names: "rw" means configuration
(read-write), and "ro" means state data (read-only).
o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list.
o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not
shown.
2. Design of Data Model
The goal of this document is to define a data model that provides a
common user interface to the PPP protocol. There is very information
that is designated as "mandatory", providing freedom for vendors to
adapt this data model to their respective product implementations.
2.1. Overview
The PPP YANG module defined in this document has all the common
building blocks for the PPP protocol.
module: ietf-if-ext-ppp
augment /if:interfaces/if:interface:
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 3]
Internet-Draft PPP Yang Data Model February 2017
+--rw ppp
+--rw enabled? boolean
+--rw authentication! {ppp-authentication}?
+--rw (authentication-mode)
| +--:(pap)
| | +--rw pap empty
| +--:(chap)
| +--rw chap empty
+--rw user? string
+--rw password!
+--rw (chap-mode)
+--:(cipher)
| +--rw cipher? string
+--:(simple)
+--rw simple? string
3. PPP YANG Module
<CODE BEGINS> file "intf-if-ext-ppp@2016-11-19.yang"
module ietf-if-ext-ppp {
namespace "urn:ietf:params:xml:ns:yang:ietf-if-ext-ppp";
prefix "ppp";
import ietf-interfaces {
prefix if;
}
import iana-crypt-hash {
prefix ianach;
}
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"Editor: Hansance Han
<mailto:hansance.han@ericsson.com>
Editor: Xianghua Gu
<mailto:xianghua.gu@ericsson.com>
Editor: Hua Lv
<mailto:hua.lv@ericsson.com>
Editor: James Zhang
<mailto:james.q.zhang@ericsson.com>";
description
"This module contains a collection of YANG definitions
for managing ppp network interfaces.";
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 4]
Internet-Draft PPP Yang Data Model February 2017
revision 2016-11-24 {
description
"Latest revision.";
reference
"RFC 7223: A YANG Data Model for Interface Management";
}
feature ppp-authentication {
description
"Indicates that the interface supports configuration of
ppp authentication.";
}
augment "/if:interfaces/if:interface" {
when "if:type = 'ppp'";
description
"PPP link protocol is extension under interface.";
container ppp {
description
"A ppp interface must specify the global parameters.";
leaf enabled {
type boolean;
default "true";
description
"This leaf contains the configured, desired state of the
ppp link-protocol.";
}
container authentication {
if-feature ppp-authentication;
presence "";
description
"The authentication configuration subtree.";
choice authentication-mode {
mandatory true;
description
"The authentication sub-mode pap and chap.";
case pap {
leaf pap {
type empty;
description
"Authentication pap for PPP.";
}
}
case chap {
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 5]
Internet-Draft PPP Yang Data Model February 2017
leaf chap {
type empty;
description
"Authentication pap for PPP.";
}
}
}
leaf user {
type string;
description "the user name string identifying ppp";
}
container password {
presence "";
description
"The password configuraiton sub-tree.";
choice chap-mode {
mandatory true;
description
"The chap mode configuration for cipher and simple.";
case cipher {
leaf cipher {
type ianach:crypt-hash;
description
"The password for cipher type.";
}
}
case simple {
leaf simple {
type ianach:crypt-hash;
description
"The password for simple type.";
}
}
}
}
}
// other ppp specific params...
}
}
}
<CODE ENDS>
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 6]
Internet-Draft PPP Yang Data Model February 2017
4. Security Considerations
The data model defined does not create any security implications.
5. IANA Considerations
This draft does not request any IANA action.
6. Normative References
[RFC7224] M. Bjorklund, "IANA Interface Type YANG model", RFC 7224
May 2014, <https://tools.ietf.org/html/rfc7224>.
[RFC1661] Simpson, W., "The Point-to-Point Protocol(PPP)", STD 51,
RFC 1661, July 1999, <https://tools.ietf.org/html/rfc1661>.
[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>.
[RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6021,
DOI 10.17487/RFC6021, October 2010, <http://www.rfc-
editor.org/info/rfc6021>.
7. Appendix A. Change Log
A.1. Changes from 00 to 01
o Changed namespace with "intf-if-ext-ppp".
o Updated file name "intf-if-ext-ppp".
A.2. Changes from 01 to 02
o Changed module name with "ietf-if-ext-ppp".
Authors' Addresses
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 7]
Internet-Draft PPP Yang Data Model February 2017
Hansance Han
Ericsson (China) Communications Company Ltd.
Ericsson Tower, No. 5 Lize East Street,
Chaoyang District Beijing 100102, P.R. China
Email: hansance.han@ericsson.com
Hua Lv
Ericsson (China) Communications Company Ltd.
Ericsson Tower, No. 5 Lize East Street,
Chaoyang District Beijing 100102, P.R. China
Email: hua.lv@ericsson.com
Xianghua Gu
Ericsson (China) Communications Company Ltd.
Ericsson Tower, No. 5 Lize East Street,
Chaoyang District Beijing 100102, P.R. China
Email: xianghua.gu@ericsson.com
James Zhang
Ericsson (China) Communications Company Ltd.
Ericsson Tower, No. 5 Lize East Street,
Chaoyang District Beijing 100102, P.R. China
Email: james.q.zhang@ericsson.com
Hans&Xianghua&Hua&James Expires August 27, 2017 [Page 8]
