draft-ietf-netmod-ip-cfg-02.txt   draft-ietf-netmod-ip-cfg-03.txt 
Network Working Group M. Bjorklund Network Working Group M. Bjorklund
Internet-Draft Tail-f Systems Internet-Draft Tail-f Systems
Intended status: Standards Track February 8, 2012 Intended status: Standards Track April 29, 2012
Expires: August 11, 2012 Expires: October 31, 2012
A YANG Data Model for IP Configuration A YANG Data Model for IP Configuration
draft-ietf-netmod-ip-cfg-02 draft-ietf-netmod-ip-cfg-03
Abstract Abstract
This document defines a YANG data model for configuration of IP This document defines a YANG data model for configuration of IP
addresses on network interfaces. implementations.
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on August 11, 2012. This Internet-Draft will expire on October 31, 2012.
Copyright Notice Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the Copyright (c) 2012 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. IP Data Model . . . . . . . . . . . . . . . . . . . . . . . . 4 2. IP Data Model . . . . . . . . . . . . . . . . . . . . . . . . 4
3. IP Address YANG Module . . . . . . . . . . . . . . . . . . . . 5 3. Relationship to IP-MIB . . . . . . . . . . . . . . . . . . . . 5
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10 4. IP configuration YANG Module . . . . . . . . . . . . . . . . . 6
5. Security Considerations . . . . . . . . . . . . . . . . . . . 11 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
6. Normative References . . . . . . . . . . . . . . . . . . . . . 12 6. Security Considerations . . . . . . . . . . . . . . . . . . . 13
Appendix A. Example: NETCONF <get> reply . . . . . . . . . . . . 13 7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 14 7.1. Normative References . . . . . . . . . . . . . . . . . . . 14
7.2. Informative References . . . . . . . . . . . . . . . . . . 14
Appendix A. Example: NETCONF <get> reply . . . . . . . . . . . . 15
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 16
1. Introduction 1. Introduction
This document defines a YANG [RFC6020] data model for configuration This document defines a YANG [RFC6020] data model for configuration
of IP addresses on network interfaces. of IP implementations.
1.1. Terminology
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14, [RFC2119]. 14, [RFC2119].
The following terms are defined in [RFC6241] and are not redefined
here:
o client
o server
The following terms are defined in [RFC6020] and are not redefined
here:
o augment
o data model
o data node
2. IP Data Model 2. IP Data Model
The module "ietf-ip" augments the "interface" list defined in the The module "ietf-ip" augments the "interface" list defined in the
"ietf-interfaces" module [I-D.ietf-netmod-interfaces-cfg] with the "ietf-interfaces" module [I-D.ietf-netmod-interfaces-cfg] with the
following nodes, where square brackets are used to enclose a list's following nodes, where square brackets are used to enclose a list's
keys, and "?" means that the node is optional. Choice and case nodes keys, and "?" means that the node is optional. Choice and case nodes
are enclosed in parenthesis, and a case node is marked with a colon are enclosed in parenthesis, and a case node is marked with a colon
(":"). (":").
+--rw if:interfaces +--rw if:interfaces
+--rw if:interface [name] +--rw if:interface [name]
... ...
+--rw ipv4 +--rw ipv4
| +--rw enabled? boolean | +--rw enabled? boolean
| +--rw ip-forwarding? boolean
| +--rw address [ip] | +--rw address [ip]
| +--rw ip inet:ipv4-address | +--rw ip inet:ipv4-address
| +--rw (subnet)? | +--rw (subnet)?
| +--:(prefix-length) | +--:(prefix-length)
| | +--rw ip:prefix-length? uint8 | | +--rw ip:prefix-length? uint8
| +--:(netmask) | +--:(netmask)
| +--rw ip:netmask? inet:ipv4-address | +--rw ip:netmask? inet:ipv4-address
+--rw ipv6 +--rw ipv6
+--rw enabled? boolean +--rw enabled? boolean
| +--rw ip-forwarding? boolean
+--rw address [ip] +--rw address [ip]
| +--rw ip inet:ipv6-address | +--rw ip inet:ipv6-address
| +--rw prefix-length? uint8 | +--rw prefix-length? uint8
+--rw dup-addr-detect-transmits? uint32
+--rw autoconf +--rw autoconf
+--rw create-global-addresses? boolean +--rw create-global-addresses? boolean
+--rw dup-addr-detect-transmits? uint32 +--rw create-temporary-addressed? boolean
+--rw temporary-valid-lifetime? uint32
+--rw temporary-preferred-lifetime? uint32
The data model defines two containers, "ipv4" and "ipv6", The data model defines two containers, "ipv4" and "ipv6",
representing the IPv4 and IPv6 address families. In each container, representing the IPv4 and IPv6 address families. In each container,
there is a leaf "enabled" that controls if the address familiy is there is a leaf "enabled" that controls if the address family is
enabled on that interface. In each container, there is also a list enabled on that interface, and a leaf "ip-forwarding" that controls
of manually configured addresses. if ip packet forwarding for the address family is enabled on the
interface. In each container, there is also a list of manually
configured addresses.
3. IP Address YANG Module Configuration parameters to control IP routing are defined in
[I-D.ietf-netmod-routing-cfg].
3. Relationship to IP-MIB
If the device implements IP-MIB [RFC4293], each entry in the "ipv4/
address" and "ipv6/address" lists is mapped to one ipAddressEntry,
where the ipAddressIfIndex refers to the interface where the
"address" entry is configured.
The IP-MIB defines objects to control IPv6 Router Advertisement. The
corresponding YANG nodes are defined in
[I-D.ietf-netmod-routing-cfg].
The objects ipNetToPhysicalTable and ipAddressStatus are writable in
the IP-MIB but do not represent configuration, and are thus not
mapped to the YANG module.
The following table lists the YANG nodes with corresponding objects
in the IP-MIB.
+--------------------+-----------------------------------+
| YANG node | IP-MIB object |
+--------------------+-----------------------------------+
| ipv4/enabled | ipv4InterfaceEnableStatus |
| ipv4/address | ipAddressEntry |
| ipv4/address/ip | ipAddressAddrType / ipAddressAddr |
| ipv6/enabled | ipv6InterfaceEnableStatus |
| ipv6/ip-forwarding | ipv6InterfaceForwarding |
| ipv6/address | ipAddressEntry |
| ipv6/address/ip | ipAddressAddrType / ipAddressAddr |
+--------------------+-----------------------------------+
Mapping of YANG nodes to IP-MIB objects
4. IP configuration YANG Module
This module imports typedefs from [RFC6021] and This module imports typedefs from [RFC6021] and
[I-D.ietf-netmod-interfaces-cfg], and references [RFC4862]. [I-D.ietf-netmod-interfaces-cfg], and references [RFC4861] and
[RFC4862].
RFC Ed.: update the date below with the date of RFC publication and RFC Ed.: update the date below with the date of RFC publication and
remove this note. remove this note.
<CODE BEGINS> file "ietf-ip@2012-02-08.yang" <CODE BEGINS> file "ietf-ip@2012-04-29.yang"
module ietf-ip { module ietf-ip {
namespace "urn:ietf:params:xml:ns:yang:ietf-ip"; namespace "urn:ietf:params:xml:ns:yang:ietf-ip";
prefix ip; prefix ip;
import ietf-interfaces { import ietf-interfaces {
prefix if; prefix if;
} }
import ietf-inet-types { import ietf-inet-types {
skipping to change at page 5, line 45 skipping to change at page 6, line 46
<mailto:david.kessens@nsn.com> <mailto:david.kessens@nsn.com>
WG Chair: Juergen Schoenwaelder WG Chair: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de> <mailto:j.schoenwaelder@jacobs-university.de>
Editor: Martin Bjorklund Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>"; <mailto:mbj@tail-f.com>";
description description
"This module contains a collection of YANG definitions for "This module contains a collection of YANG definitions for
configuring IP addresses on network interfaces. configuring IP implementations.
Copyright (c) 2011 IETF Trust and the persons identified as Copyright (c) 2011 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this // RFC Ed.: replace XXXX with actual RFC number and remove this
// note. // note.
// RFC Ed.: update the date below with the date of RFC publication // RFC Ed.: update the date below with the date of RFC publication
// and remove this note. // and remove this note.
revision 2012-02-08 { revision 2012-04-29 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: A YANG Data Model for IP Configuration"; "RFC XXXX: A YANG Data Model for IP Configuration";
} }
/* Features */ /* Features */
feature non-contiguous-netmasks { feature non-contiguous-netmasks {
description description
"Indicates support for configuring non-contiguous "Indicates support for configuring non-contiguous
subnet masks."; subnet masks.";
} }
/* Data nodes */ /* Data nodes */
augment "/if:interfaces/if:interface" { augment "/if:interfaces/if:interface" {
description description
"Parameters for configuring IP addresses on interfaces. "Parameters for configuring IP on interfaces.
If an interface is not capable of running IP, the server If an interface is not capable of running IP, the server
must not allow the client to configure these parameters."; must not allow the client to configure these parameters.";
container ipv4 { container ipv4 {
description description
"Parameters for the IPv4 address family."; "Parameters for the IPv4 address family.";
leaf enabled { leaf enabled {
type boolean; type boolean;
default true; default true;
description description
"Controls if IPv4 is enabled or disabled on this "Controls if IPv4 is enabled or disabled on this
interface."; interface.";
} }
leaf ip-forwarding {
type boolean;
default false;
description
"Controls if IPv4 packet forwarding is enabled or disabled
on this interface.";
}
list address { list address {
key "ip"; key "ip";
description description
"The list of manually configured IPv4 addresses "The list of manually configured IPv4 addresses
on the interface."; on the interface.";
leaf ip { leaf ip {
type inet:ipv4-address; type inet:ipv4-address;
description description
"The IPv4 address on the interface."; "The IPv4 address on the interface.";
skipping to change at page 7, line 49 skipping to change at page 9, line 9
description description
"Parameters for the IPv6 address family."; "Parameters for the IPv6 address family.";
leaf enabled { leaf enabled {
type boolean; type boolean;
default true; default true;
description description
"Controls if IPv6 is enabled or disabled on this "Controls if IPv6 is enabled or disabled on this
interface."; interface.";
} }
leaf ip-forwarding {
type boolean;
default false;
description
"Controls if IPv6 packet forwarding is enabled or disabled
on this interface.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6)
Section 6.2.1, IsRouter";
}
list address { list address {
key "ip"; key "ip";
description description
"The list of manually configured IPv6 addresses "The list of manually configured IPv6 addresses
on the interface."; on the interface.";
leaf ip { leaf ip {
type inet:ipv6-address; type inet:ipv6-address;
description description
"The IPv6 address on the interface."; "The IPv6 address on the interface.";
} }
leaf prefix-length { leaf prefix-length {
type uint8 { type uint8 {
range "0..128"; range "0..128";
} }
default 128; default 128;
description description
"The length of the subnet prefix."; "The length of the subnet prefix.";
} }
} }
leaf dup-addr-detect-transmits {
type uint32;
default 1;
description
"The number of consecutive Neighbor Solicitation messages
sent while performing Duplicate Address Detection on a
tentative address. A value of zero indicates that
Duplicate Address Detection is not performed on
tentative addresses. A value of one indicates a single
transmission with no follow-up retransmissions.";
reference
"RFC 4862: IPv6 Stateless Address Autoconfiguration";
}
container autoconf { container autoconf {
description description
"Parameters to control the autoconfiguration of IPv6 "Parameters to control the autoconfiguration of IPv6
addresses, as described in RFC 4862."; addresses, as described in RFC 4862.";
reference reference
"RFC 4862: IPv6 Stateless Address Autoconfiguration"; "RFC 4862: IPv6 Stateless Address Autoconfiguration";
// Open Issue #ip-02: should we have a leaf to control
// the creation of a link-local address?
//leaf create-link-local-address { ... default true; ... }
leaf create-global-addresses { leaf create-global-addresses {
// Open Issue #ip-06: should we have a feature here?
//if-feature ipv6-host;
type boolean; type boolean;
default true; default true;
description description
"If enabled, the host creates global addresses as "If enabled, the host creates global addresses as
described in section 5.5 of RFC 4862."; described in section 5.5 of RFC 4862.";
reference reference
"RFC 4862: IPv6 Stateless Address Autoconfiguration"; "RFC 4862: IPv6 Stateless Address Autoconfiguration";
} }
leaf dup-addr-detect-transmits { leaf create-temporary-addressed {
type boolean;
default false;
description
"If enabled, the host creates temporary addresses as
described in RFC 4941.";
reference
"RFC 4941: Privacy Extensions for Stateless Address
Autoconfiguration in IPv6";
}
leaf temporary-valid-lifetime {
type uint32; type uint32;
default 1; units "seconds";
default 604800;
description description
"The number of consecutive Neighbor Solicitation messages "The time the temporary address is valid.";
sent while performing Duplicate Address Detection on a
tentative address. A value of zero indicates that
Duplicate Address Detection is not performed on
tentative addresses. A value of one indicates a single
transmission with no follow-up retransmissions.";
reference reference
"RFC 4862: IPv6 Stateless Address Autoconfiguration"; "RFC 4941: Privacy Extensions for Stateless Address
Autoconfiguration in IPv6
- TEMP_VALID_LIFETIME";
} }
leaf temporary-preferred-lifetime {
type uint32;
units "seconds";
default 86400;
description
"The time the temporary address is preferred.";
reference
"RFC 4941: Privacy Extensions for Stateless Address
Autoconfiguration in IPv6
- TEMP_PREFERED_LIFETIME";
}
} }
} }
} }
} }
<CODE ENDS> <CODE ENDS>
4. IANA Considerations 5. IANA Considerations
This document registers a URI in the IETF XML registry [RFC3688]. This document registers a URI in the IETF XML registry [RFC3688].
Following the format in RFC 3688, the following registration is Following the format in RFC 3688, the following registration is
requested to be made. requested to be made.
URI: urn:ietf:params:xml:ns:yang:ietf-ip URI: urn:ietf:params:xml:ns:yang:ietf-ip
Registrant Contact: The NETMOD WG of the IETF. Registrant Contact: The NETMOD WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
This document registers a YANG module in the YANG Module Names This document registers a YANG module in the YANG Module Names
registry [RFC6020]. registry [RFC6020].
name: ietf-ip name: ietf-ip
namespace: urn:ietf:params:xml:ns:yang:ietf-ip namespace: urn:ietf:params:xml:ns:yang:ietf-ip
prefix: ip prefix: ip
reference: RFC XXXX reference: RFC XXXX
5. Security Considerations 6. Security Considerations
The YANG module defined in this memo is designed to be accessed via The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the
secure transport layer and the mandatory-to-implement secure secure transport layer and the mandatory-to-implement secure
transport is SSH [RFC6242]. transport is SSH [RFC6242].
There are a number of data nodes defined in the YANG module which are There are a number of data nodes defined in the YANG module which are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config) in some network environments. Write operations (e.g., edit-config)
skipping to change at page 12, line 5 skipping to change at page 14, line 5
interface or deny access to some or all of the network via that interface or deny access to some or all of the network via that
protocol. protocol.
ipv4/address and ipv6/address: These lists specify the configured IP ipv4/address and ipv6/address: These lists specify the configured IP
addresses on an interface. By modifying this information, an addresses on an interface. By modifying this information, an
attacker can cause a node to either ignore messages destined to it attacker can cause a node to either ignore messages destined to it
or accept (at least at the IP layer) messages it would otherwise or accept (at least at the IP layer) messages it would otherwise
ignore. The use of filtering or security associations may reduce ignore. The use of filtering or security associations may reduce
the potential damage in the latter case. the potential damage in the latter case.
6. Normative References 7. References
7.1. Normative References
[I-D.ietf-netmod-interfaces-cfg] [I-D.ietf-netmod-interfaces-cfg]
Bjorklund, M., "A YANG Data Model for Interface Bjorklund, M., "A YANG Data Model for Interface
Configuration", draft-ietf-netmod-interfaces-cfg-01 (work Configuration", draft-ietf-netmod-interfaces-cfg-04 (work
in progress), May 2011. in progress), April 2011.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004. January 2004.
[RFC4861] Narten, T., Nordmark, E., Simpson, W., and H. Soliman,
"Neighbor Discovery for IP version 6 (IPv6)", RFC 4861,
September 2007.
[RFC4862] Thomson, S., Narten, T., and T. Jinmei, "IPv6 Stateless [RFC4862] Thomson, S., Narten, T., and T. Jinmei, "IPv6 Stateless
Address Autoconfiguration", RFC 4862, September 2007. Address Autoconfiguration", RFC 4862, September 2007.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)", RFC 6020, Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010. October 2010.
[RFC6021] Schoenwaelder, J., "Common YANG Data Types", RFC 6021, [RFC6021] Schoenwaelder, J., "Common YANG Data Types", RFC 6021,
October 2010. October 2010.
[RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
Bierman, "Network Configuration Protocol (NETCONF)", Bierman, "Network Configuration Protocol (NETCONF)",
RFC 6241, June 2011. RFC 6241, June 2011.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011. Shell (SSH)", RFC 6242, June 2011.
7.2. Informative References
[I-D.ietf-netmod-routing-cfg]
Lhotka, L., "A YANG Data Model for Routing Configuration",
draft-ietf-netmod-routing-cfg-02 (work in progress),
February 2012.
[RFC4293] Routhier, S., "Management Information Base for the
Internet Protocol (IP)", RFC 4293, April 2006.
Appendix A. Example: NETCONF <get> reply Appendix A. Example: NETCONF <get> reply
This section gives an example of a reply to the NETCONF <get> request This section gives an example of a reply to the NETCONF <get> request
for a device that implements the data model defined in this document. for a device that implements the data model defined in this document.
<rpc-reply <rpc-reply
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
message-id="101"> message-id="101">
<data> <data>
<interfaces <interfaces
 End of changes. 35 change blocks. 
45 lines changed or deleted 170 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/