--- 1/draft-ietf-netmod-interfaces-cfg-10.txt 2013-05-15 15:14:24.320921373 +0100 +++ 2/draft-ietf-netmod-interfaces-cfg-11.txt 2013-05-15 15:14:24.384922973 +0100 @@ -1,129 +1,160 @@ Network Working Group M. Bjorklund Internet-Draft Tail-f Systems -Intended status: Standards Track April 19, 2013 -Expires: October 21, 2013 +Intended status: Standards Track May 15, 2013 +Expires: November 16, 2013 A YANG Data Model for Interface Management - draft-ietf-netmod-interfaces-cfg-10 + draft-ietf-netmod-interfaces-cfg-11 Abstract This document defines a YANG data model for the management of network interfaces. It is expected that interface type specific data models augment the generic interfaces data model defined in this document. + The data model includes configuration data, state data and counters + for the collection of statistics. 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 October 21, 2013. + This Internet-Draft will expire on November 16, 2013. Copyright Notice Copyright (c) 2013 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 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 . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 - 2. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . 4 - 3. Interfaces Data Model . . . . . . . . . . . . . . . . . . . . 5 - 3.1. The interface List . . . . . . . . . . . . . . . . . . . . 5 - 3.2. Interface References . . . . . . . . . . . . . . . . . . . 6 - 3.3. Interface Layering . . . . . . . . . . . . . . . . . . . . 6 - 4. Relationship to the IF-MIB . . . . . . . . . . . . . . . . . . 8 - 5. Interfaces YANG Module . . . . . . . . . . . . . . . . . . . . 10 - 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 23 - 7. Security Considerations . . . . . . . . . . . . . . . . . . . 24 - 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 25 - 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 26 - 9.1. Normative References . . . . . . . . . . . . . . . . . . . 26 - 9.2. Informative References . . . . . . . . . . . . . . . . . . 26 - Appendix A. Example: Ethernet Interface Module . . . . . . . . . 27 - Appendix B. Example: Ethernet Bonding Interface Module . . . . . 29 - Appendix C. Example: VLAN Interface Module . . . . . . . . . . . 30 - Appendix D. Example: NETCONF reply . . . . . . . . . . . . 31 - Appendix E. Examples: Interface Naming Schemes . . . . . . . . . 32 - E.1. Router with Restricted Interface Names . . . . . . . . . . 32 - E.2. Router with Arbitrary Interface Names . . . . . . . . . . 33 - E.3. Ethernet Switch with Restricted Interface Names . . . . . 33 - E.4. Generic Host with Restricted Interface Names . . . . . . . 34 - E.5. Generic Host with Arbitrary Interface Names . . . . . . . 35 - Appendix F. ChangeLog . . . . . . . . . . . . . . . . . . . . . . 37 - F.1. Version -08 . . . . . . . . . . . . . . . . . . . . . . . 37 - F.2. Version -07 . . . . . . . . . . . . . . . . . . . . . . . 37 - F.3. Version -06 . . . . . . . . . . . . . . . . . . . . . . . 37 - F.4. Version -05 . . . . . . . . . . . . . . . . . . . . . . . 37 - F.5. Version -04 . . . . . . . . . . . . . . . . . . . . . . . 37 - F.6. Version -03 . . . . . . . . . . . . . . . . . . . . . . . 37 - F.7. Version -02 . . . . . . . . . . . . . . . . . . . . . . . 38 - F.8. Version -01 . . . . . . . . . . . . . . . . . . . . . . . 38 - Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 39 + 1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 3 + 2. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . 5 + 3. Interfaces Data Model . . . . . . . . . . . . . . . . . . . . 6 + 3.1. The interface Lists . . . . . . . . . . . . . . . . . . . 6 + 3.2. Interface References . . . . . . . . . . . . . . . . . . . 7 + 3.3. Interface Layering . . . . . . . . . . . . . . . . . . . . 7 + 4. Relationship to the IF-MIB . . . . . . . . . . . . . . . . . . 9 + 5. Interfaces YANG Module . . . . . . . . . . . . . . . . . . . . 11 + 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 26 + 7. Security Considerations . . . . . . . . . . . . . . . . . . . 27 + 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 28 + 9. References . . . . . . . . . . . . . . . . . . . . . . . . . . 29 + 9.1. Normative References . . . . . . . . . . . . . . . . . . . 29 + 9.2. Informative References . . . . . . . . . . . . . . . . . . 29 + Appendix A. Example: Ethernet Interface Module . . . . . . . . . 30 + Appendix B. Example: Ethernet Bonding Interface Module . . . . . 32 + Appendix C. Example: VLAN Interface Module . . . . . . . . . . . 33 + Appendix D. Example: NETCONF reply . . . . . . . . . . . . 34 + Appendix E. Examples: Interface Naming Schemes . . . . . . . . . 37 + E.1. Router with Restricted Interface Names . . . . . . . . . . 37 + E.2. Router with Arbitrary Interface Names . . . . . . . . . . 38 + E.3. Ethernet Switch with Restricted Interface Names . . . . . 39 + E.4. Generic Host with Restricted Interface Names . . . . . . . 39 + E.5. Generic Host with Arbitrary Interface Names . . . . . . . 40 + Appendix F. ChangeLog . . . . . . . . . . . . . . . . . . . . . . 42 + F.1. Version -11 . . . . . . . . . . . . . . . . . . . . . . . 42 + F.2. Version -08 . . . . . . . . . . . . . . . . . . . . . . . 42 + F.3. Version -07 . . . . . . . . . . . . . . . . . . . . . . . 42 + F.4. Version -06 . . . . . . . . . . . . . . . . . . . . . . . 42 + F.5. Version -05 . . . . . . . . . . . . . . . . . . . . . . . 42 + F.6. Version -04 . . . . . . . . . . . . . . . . . . . . . . . 43 + F.7. Version -03 . . . . . . . . . . . . . . . . . . . . . . . 43 + F.8. Version -02 . . . . . . . . . . . . . . . . . . . . . . . 43 + F.9. Version -01 . . . . . . . . . . . . . . . . . . . . . . . 43 + Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 44 1. Introduction This document defines a YANG [RFC6020] data model for the management of network interfaces. It is expected that interface type specific data models augment the generic interfaces data model defined in this document. Network interfaces are central to the management of many Internet protocols. Thus, it is important to establish a common data model - for how interfaces are identified and configured. + for how interfaces are identified, configured, and monitored. + + The data model includes configuration data, state data and counters + for the collection of statistics. 1.1. Terminology The keywords "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 defined in [RFC6241] and are not redefined here: o client + o configuration data + 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 +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" state data (read-only). + + o Symbols after data node names: "?" means an optional node 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. Objectives This section describes some of the design objectives for the model presented in Section 5. o It is recognized that existing implementations will have to map the interface data model defined in this memo to their proprietary native data model. The data model should be simple to facilitate such mappings. @@ -131,116 +162,129 @@ as-is, without requiring a mapping to a different native model. o References to interfaces should be as simple as possible, preferably by using a single leafref. o The mapping to ifIndex [RFC2863] used by SNMP to identify interfaces must be clear. o The model must support interface layering, both simple layering where one interface is layered on top of exactly one other - interface, and more complex scenarios where one interface is - aggregated over N other interfaces, or when N interfaces are - multiplexed over one other interface. + interface, and more complex scenarios where one interface results + from the aggregation of N other interfaces, or when N interfaces + are multiplexed over one other interface. o The data model should support the pre-provisioning of interface configuration, i.e., it should be possible to configure an interface whose physical interface hardware is not present on the device. It is recommended that devices that support dynamic addition and removal of physical interfaces also support pre- provisioning. + o The data model should support both physical interfaces as well as + logical interfaces. + + o The data model should include read-only counters in order to + gather statistics for octets, packets and errors, sent and + received. + 3. Interfaces Data Model - The data model in the module "ietf-interfaces" has the following - structure, where square brackets are used to enclose a list's keys, - "?" means that the leaf is optional, and "*" denotes a leaf-list: + This document defines the YANG module "ietf-interfaces", which has + the following structure: +--rw interfaces - +--rw interface [name] - +--rw name string - +--rw description? string - +--rw type ianaift:iana-if-type - +--rw location? string - +--rw enabled? boolean - +--ro oper-status? enumeration + | +--rw interface* [name] + | +--rw name string + | +--rw description? string + | +--rw type ianaift:iana-if-type + | +--rw enabled? boolean + | +--rw link-up-down-trap-enable? enumeration + +--ro interfaces-state + +--ro interface* [name] + +--ro name string + +--ro type ianaift:iana-if-type + +--ro admin-status enumeration + +--ro oper-status enumeration +--ro last-change? yang:date-and-time - +--ro if-index? int32 - +--rw link-up-down-trap-enable? enumeration + +--ro if-index int32 +--ro phys-address? yang:phys-address - +--ro higher-layer-if* interface-ref - +--ro lower-layer-if* interface-ref + +--ro higher-layer-if* interface-state-ref + +--ro lower-layer-if* interface-state-ref +--ro speed? yang:gauge64 +--ro statistics - +--ro discontinuity-time? yang:date-and-time + +--ro discontinuity-time yang:date-and-time +--ro in-octets? yang:counter64 +--ro in-unicast-pkts? yang:counter64 +--ro in-broadcast-pkts? yang:counter64 +--ro in-multicast-pkts? yang:counter64 +--ro in-discards? yang:counter32 +--ro in-errors? yang:counter32 +--ro in-unknown-protos? yang:counter32 +--ro out-octets? yang:counter64 +--ro out-unicast-pkts? yang:counter64 +--ro out-broadcast-pkts? yang:counter64 +--ro out-multicast-pkts? yang:counter64 +--ro out-discards? yang:counter32 +--ro out-errors? yang:counter32 -3.1. The interface List +3.1. The interface Lists The data model for interfaces presented in this document uses a flat list of interfaces. Each interface in the list is identified by its - name. Furthermore, each interface has a mandatory "type" leaf, and - an optional "location" leaf. The combination of "type" and - "location" is unique within the interface list. + name. Furthermore, each interface has a mandatory "type" leaf. + + There is one list of configured interfaces ("/interfaces/interface"), + and a separate list for the operational state of all interfaces + ("/interfaces-state/interface"). It is expected that interface type specific data models augment the - interface list, and use the "type" leaf to make the augmentation + interface lists, and use the "type" leaf to make the augmentation conditional. As an example of such an interface type specific augmentation, consider this YANG snippet. For a more complete example, see Appendix A. import interfaces { prefix "if"; } augment "/if:interfaces/if:interface" { when "if:type = 'ethernetCsmacd'"; container ethernet { leaf duplex { ... } } } - The "location" leaf is a string. It is optional in the data model, - but if the type represents a physical interface, it is mandatory. - The format of this string is device- and type-dependent. The device - uses the location string to identify the physical or logical entity - that the configuration applies to. For example, if a device has a - single array of 8 ethernet ports, the location can be one of the - strings "1" to "8". As another example, if a device has N cards of M - ports, the location can be on the form "n/m", such as "1/0". + For physical interfaces, the "name" is the device-specific name of + the interface. It is used to identify the physical hardware + interface. The 'config false' list "/interfaces-state/interface" + contains all currently existing interfaces on the device. - How a client can learn which types and locations are present on a - certain device is outside the scope of this document. + If the device supports arbitrarily named logical interfaces, the + NETCONF server advertises the feature "arbitrary-names". If the + device does not advertise this feature, the names of logical + interfaces MUST match the device's naming scheme. How a client can + learn the naming scheme of such devices is outside the scope of this + document. 3.2. Interface References An interface is identified by its name, which is unique within the - server. This property is captured in the "interface-ref" typedef, - which other YANG modules SHOULD use when they need to reference an - existing interface. + server. This property is captured in the "interface-ref" and + "interface-state-ref" typedefs, which other YANG modules SHOULD use + when they need to reference a configured interface or operationally + used interface, respectively. 3.3. Interface Layering There is no generic mechanism for how an interface is configured to be layered on top of some other interface. It is expected that interface type specific models define their own data nodes for interface layering, by using "interface-ref" types to reference lower layers. Below is an example of a model with such nodes. For a more complete @@ -263,48 +307,62 @@ } // other bonding config params, failover times etc. } Two state data leaf-lists, "higher-layer-if" and "lower-layer-if", represent a read-only view of the interface layering hierarchy. 4. Relationship to the IF-MIB If the device implements IF-MIB [RFC2863], each entry in the - "interface" list is typically mapped to one ifEntry. The "if-index" - leaf MUST contain the value of the corresponding ifEntry's ifIndex. + "/interfaces-state/interface" list is typically mapped to one + ifEntry. The "if-index" leaf MUST contain the value of the + corresponding ifEntry's ifIndex. In most cases, the "name" of an "interface" entry is mapped to ifName. ifName is defined as an DisplayString [RFC2579] which uses a - 7-bit ASCII character set. An implementation MAY restrict the + 7-bit ASCII character set. An implementation MUST restrict the allowed values for "name" to match the restrictions of ifName. The IF-MIB allows two different ifEntries to have the same ifName. - Devices that support this feature, and also support the configuration - of these interfaces using the "interface" list, cannot have a 1-1 - mapping between the "name" leaf and ifName. + Devices that support this feature, and also support the data model + defined in this document, cannot have a 1-1 mapping between the + "name" leaf and ifName. + + The configured "description" of an "interface" has traditionally been + mapped to ifAlias in some implementations. This document allows this + mapping, but implementers should be aware of the differences in the + value space and persistence for these objects. See the YANG module + definition of the leaf "description" in Section 5 for details. The IF-MIB also defines the writable object ifPromiscuousMode. Since this object typically is not a configuration object, it is not mapped to the "ietf-interfaces" module. + There are a number of counters in the IF-MIB that exist in two + versions; one with 32 bits and one with 64 bits. The YANG module + contains the 64 bits counters only. Note that NETCONF and SNMP may + differ in the time granularity in which they provide access to the + counters. For example, it is common that SNMP implementations cache + counter values for some time. + The following table lists the YANG data nodes with corresponding objects in the IF-MIB. +----------------------------------+------------------------+ | YANG data node | IF-MIB object | +----------------------------------+------------------------+ | interface | ifEntry | | name | ifName | | description | ifAlias | | type | ifType | - | enabled | ifAdminStatus | + | enabled / admin-status | ifAdminStatus | | oper-status | ifOperStatus | | last-change | ifLastChange | | if-index | ifIndex | | link-up-down-trap-enable | ifLinkUpDownTrapEnable | | phys-address | ifPhysAddress | | higher-layer-if / lower-layer-if | ifStackTable | | speed | ifSpeed | | in-octets | ifHCInOctets | | in-unicast-pkts | ifHCInUcastPkts | | in-broadcast-pkts | ifHCInBroadcastPkts | @@ -313,31 +371,31 @@ | in-errors | ifInErrors | | in-unknown-protos | ifInUnknownProtos | | out-octets | ifHCOutOctets | | out-unicast-pkts | ifHCOutUcastPkts | | out-broadcast-pkts | ifHCOutBroadcastPkts | | out-multicast-pkts | ifHCOutMulticastPkts | | out-discards | ifOutDiscards | | out-errors | ifOutErrors | +----------------------------------+------------------------+ - Mapping of YANG data nodes to IF-MIB objects + YANG data nodes and related IF-MIB objects 5. Interfaces YANG Module - This YANG module imports a typedef from - [I-D.ietf-netmod-iana-if-type]. + This YANG module imports typedefs from [I-D.ietf-netmod-rfc6021-bis] + and [I-D.ietf-netmod-iana-if-type]. RFC Ed.: update the date below with the date of RFC publication and remove this note. - file "ietf-interfaces@2013-02-06.yang" + file "ietf-interfaces@2013-05-15.yang" module ietf-interfaces { namespace "urn:ietf:params:xml:ns:yang:ietf-interfaces"; prefix if; import ietf-yang-types { prefix yang; } import iana-if-type { @@ -357,165 +415,312 @@ WG Chair: Juergen Schoenwaelder Editor: Martin Bjorklund "; description "This module contains a collection of YANG definitions for managing network interfaces. - Copyright (c) 2012 IETF Trust and the persons identified as + Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: update the date below with the date of RFC publication // and remove this note. - revision 2013-02-06 { + revision 2013-05-15 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Interface Management"; } /* Typedefs */ typedef interface-ref { type leafref { path "/if:interfaces/if:interface/if:name"; } description "This type is used by data models that need to reference - interfaces."; + configured interfaces."; + } + + typedef interface-state-ref { + type leafref { + path "/if:interfaces-state/if:interface/if:name"; + } + description + "This type is used by data models that need to reference + the operationally present interfaces."; } /* Features */ feature arbitrary-names { description - "This feature indicates that the server allows interfaces to - be named arbitrarily."; + "This feature indicates that the device allows logical + interfaces to be named arbitrarily."; + } + + feature pre-provisioning { + description + "This feature indicates that the device supports + pre-provisioning of interface configuration, i.e., it is + possible to configure an interface whose physical interface + hardware is not present on the device."; } feature if-mib { description - "This feature indicates that the server implements IF-MIB."; + "This feature indicates that the device implements IF-MIB."; reference "RFC 2863: The Interfaces Group MIB"; } /* Data nodes */ container interfaces { description - "Interface parameters."; + "Interface configuration parameters."; list interface { key "name"; - unique "type location"; description - "The list of interfaces on the device."; + "The list of configured interfaces on the device. + + The operational state of an interface is available in the + /interfaces-state/interface list. If the configuration of a + physical interface cannot be used by the system (e.g., the + physical interface present is not matching the interface + type), then the configuration is not applied to the physical + interface shown in the /interfaces-state/interface list. If + the the configuration of a logical interface cannot be used + by the system, the configured interface is not instantiated + in the /interfaces-state/interface list."; leaf name { type string; description "The name of the interface. A device MAY restrict the allowed values for this leaf, - possibly depending on the type and location. + possibly depending on the type of the interface. - If the device allows arbitrarily named interfaces, the - feature 'arbitrary-names' is advertised. + For physical interfaces, this leaf is the device-specific + name of the interface. The 'config false' list + /interfaces-state/interface contains the currently + existing interfaces on the device. + + If a client tries to create configuration for a physical + interface that is not present, the server MAY reject the + request, if the implementation does not support + pre-provisioning of interfaces, or if the name refers to + an interface that can never exist in the system. + A NETCONF server MUST reply with an rpc-error with the + error-tag 'invalid-value' in this case. + + If the device supports pre-provisioning of interface + configuration, the feature 'pre-provisioning' is + advertised. + + If the device allows arbitrarily named logical interfaces, + the feature 'arbitrary-names' is advertised. + + When a configured logical interface is created by the + system, it is instantiated in the + /interface-state/interface list. Since the name in that + list MAY be mapped to ifName by an implementation, such an + implementation MUST restrict the allowed values for this + leaf so that it matches the restrictions of ifName. - This leaf MAY be mapped to ifName by an implementation. - Such an implementation MAY restrict the allowed values for - this leaf so that it matches the restrictions of ifName. If a NETCONF server that implements this restriction is sent a value that doesn't match the restriction, it MUST reply with an rpc-error with the error-tag 'invalid-value'."; - reference - "RFC 2863: The Interfaces Group MIB - ifName"; } leaf description { type string; description "A textual description of the interface. This leaf MAY be mapped to ifAlias by an implementation. - Such an implementation MAY restrict the allowed values for - this leaf so that it matches the restrictions of ifAlias. + Such an implementation MUST restrict the allowed values + for this leaf so that it matches the restrictions of + ifAlias. + If a NETCONF server that implements this restriction is sent a value that doesn't match the restriction, it MUST reply with an rpc-error with the error-tag - 'invalid-value'."; + 'invalid-value'. + + Since ifAlias is defined to be stored in non-volatile + storage, the SNMP implementation MUST map ifAlias to the + value of 'description' in the persistently stored + datastore. + + Specifically, if the device supports ':startup', when + ifAlias is read the device MUST return the value of + 'description' in the 'startup' datastore, and when it is + written, it MUST be written to the 'running' and 'startup' + datastores. Note that it is up to the implementation if + it modifies this single leaf in 'startup', or if it + performs an implicit copy-config from 'running' to + 'startup'. + + If the device does not support ':startup', ifAlias MUST + be mapped to the 'description' leaf in the 'running' + datastore."; reference "RFC 2863: The Interfaces Group MIB - ifAlias"; } + leaf type { type ianaift:iana-if-type; mandatory true; description "The type of the interface. When an interface entry is created, a server MAY initialize the type leaf with a valid value, e.g., if it is possible to derive the type from the name of the - interface."; + interface. + + If a client tries to set the type of an interface to a + value that can never be used by the system, e.g., if the + type is not supported or if the type does not match the + name of the interface, the server MUST reject the request. + A NETCONF server MUST reply with an rpc-error with the + error-tag 'invalid-value' in this case."; reference "RFC 2863: The Interfaces Group MIB - ifType"; } - leaf location { + leaf enabled { + type boolean; + default "true"; + description + "This leaf contains the configured, desired state of the + interface. + + Systems that implement the IF-MIB use the value of this + leaf in the 'running' datastore to set + IF-MIB.ifAdminStatus to 'up' or 'down' after an ifEntry + has been initialized, as described in RFC 2863. + + Changes in this leaf in the 'running' datastore are + reflected in ifAdminStatus, but if ifAdminStatus is + changed over SNMP, this leaf is not affected."; + reference + "RFC 2863: The Interfaces Group MIB - ifAdminStatus"; + } + + leaf link-up-down-trap-enable { + if-feature if-mib; + type enumeration { + enum enabled { + value 1; + } + enum disabled { + value 2; + } + } + description + "Controls whether linkUp/linkDown SNMP notifications + should be generated for this interface. + + If this node is not configured, the value 'enabled' is + operationally used by the server for interfaces which do + not operate on top of any other interface (i.e., there are + no 'lower-layer-if' entries), and 'disabled' otherwise."; + reference + "RFC 2863: The Interfaces Group MIB - + ifLinkUpDownTrapEnable"; + } + } + } + + container interfaces-state { + config false; + description + "Data nodes for the operational state of interfaces."; + + list interface { + key "name"; + + description + "The list of interfaces on the device. + + Physical interfaces detected by the system are always + present in this list, if they are configured or not."; + + leaf name { type string; description - "The device-specific location of the interface of a - particular type. The format of the location string - depends on the interface type and the device. If a - NETCONF server is sent a value that doesn't match this - format, it MUST reply with an rpc-error with the error-tag - 'invalid-value'. + "The name of the interface. - If the interface's type represents a physical interface, - this leaf MUST be set. + This leaf MAY be mapped to ifName by an implementation. + Such an implementation MUST restrict the values + for this leaf so that it matches the restrictions of + ifName."; + reference + "RFC 2863: The Interfaces Group MIB - ifName"; + } - When an interface entry is created, a server MAY - initialize the location leaf with a valid value, e.g., if - it is possible to derive the location from the name of - the interface."; + leaf type { + type ianaift:iana-if-type; + mandatory true; + description + "The type of the interface."; + reference + "RFC 2863: The Interfaces Group MIB - ifType"; } - leaf enabled { - type boolean; - default "true"; + leaf admin-status { + if-feature if-mib; + type enumeration { + enum up { + value 1; + description + "Ready to pass packets."; + } + enum down { + value 2; + description + "Not ready to pass packets and not in some test mode."; + } + enum testing { + value 3; + description + "In some test mode."; + } + } + mandatory true; description "The desired state of the interface. - This leaf contains the configured, desired state of the - interface. Systems that implement the IF-MIB use the - value of this leaf to set IF-MIB.ifAdminStatus to 'up' or - 'down' after an ifEntry has been initialized, as described - in RFC 2863."; + This leaf has the same semantics as ifAdminStatus."; reference "RFC 2863: The Interfaces Group MIB - ifAdminStatus"; } leaf oper-status { type enumeration { enum up { value 1; description "Ready to pass packets."; } @@ -544,147 +749,106 @@ value 6; description "Some component (typically hardware) is missing."; } enum lower-layer-down { value 7; description "Down due to state of lower-layer interface(s)."; } } - config false; + mandatory true; description "The current operational state of the interface. - If 'enabled' is 'false' then 'oper-status' - should be 'down'. If 'enabled' is changed to 'true' - then 'oper-status' should change to 'up' if the interface - is ready to transmit and receive network traffic; it - should change to 'dormant' if the interface is waiting for - external actions (such as a serial line waiting for an - incoming connection); it should remain in the 'down' state - if and only if there is a fault that prevents it from - going to the 'up' state; it should remain in the - 'not-present' state if the interface has missing - (typically, hardware) components."; + This leaf has the same semantics as ifOperStatus."; reference "RFC 2863: The Interfaces Group MIB - ifOperStatus"; } - leaf last-change { type yang:date-and-time; - config false; description "The time the interface entered its current operational state. If the current state was entered prior to the last re-initialization of the local network management subsystem, then this node is not present."; reference "RFC 2863: The Interfaces Group MIB - ifLastChange"; } leaf if-index { if-feature if-mib; type int32 { range "1..2147483647"; } - config false; + mandatory true; description "The ifIndex value for the ifEntry represented by this - interface. - - Media-specific modules must specify how the type is - mapped to entries in the ifTable."; + interface."; reference "RFC 2863: The Interfaces Group MIB - ifIndex"; } - leaf link-up-down-trap-enable { - if-feature if-mib; - type enumeration { - enum enabled { - value 1; - } - enum disabled { - value 2; - } - } - description - "Indicates whether linkUp/linkDown SNMP notifications - should be generated for this interface. - - If this node is not configured, the value 'enabled' is - operationally used by the server for interfaces which do - not operate on top of any other interface (i.e., there are - no 'lower-layer-if' entries), and 'disabled' otherwise."; - reference - "RFC 2863: The Interfaces Group MIB - - ifLinkUpDownTrapEnable"; - } - leaf phys-address { type yang:phys-address; - config false; description "The interface's address at its protocol sub-layer. For example, for an 802.x interface, this object normally contains a MAC address. The interface's media-specific modules must define the bit and byte ordering and the format of the value of this object. For interfaces that do not have such an address (e.g., a serial line), this node is not present."; reference "RFC 2863: The Interfaces Group MIB - ifPhysAddress"; } leaf-list higher-layer-if { - type interface-ref; - config false; + type interface-state-ref; description "A list of references to interfaces layered on top of this interface."; reference "RFC 2863: The Interfaces Group MIB - ifStackTable"; } leaf-list lower-layer-if { - type interface-ref; - config false; + type interface-state-ref; description "A list of references to interfaces layered underneath this interface."; reference "RFC 2863: The Interfaces Group MIB - ifStackTable"; } + leaf speed { type yang:gauge64; units "bits / second"; - config false; description "An estimate of the interface's current bandwidth in bits - per second. For interfaces which do not vary in + per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this node should contain the nominal bandwidth. - For interfaces that has no concept of bandwidth, this + For interfaces that have no concept of bandwidth, this node is not present."; reference "RFC 2863: The Interfaces Group MIB - ifSpeed, ifHighSpeed"; } container statistics { - config false; description "A collection of interface-related statistics objects."; leaf discontinuity-time { type yang:date-and-time; + mandatory true; description "The time on the most recent occasion at which any one or more of this interface's counters suffered a discontinuity. If no such discontinuities have occurred since the last re-initialization of the local management subsystem, then this node contains the time the local management subsystem re-initialized itself."; } leaf in-octets { @@ -919,21 +1085,24 @@ name: ietf-interfaces namespace: urn:ietf:params:xml:ns:yang:ietf-interfaces prefix: if reference: RFC XXXX 7. 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]. + transport is SSH [RFC6242]. The NETCONF access control model + [RFC6536] provides the 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., ) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability: /interfaces/interface: This list specifies the configured interfaces @@ -948,22 +1117,27 @@ The author wishes to thank Alexander Clemm, Per Hedeland, Ladislav Lhotka, and Juergen Schoenwaelder for their helpful comments. 9. References 9.1. Normative References [I-D.ietf-netmod-iana-if-type] Bjorklund, M., "IANA Interface Type and Address Family - YANG Modules", draft-ietf-netmod-iana-if-type-02 (work in - progress), April 2012. + YANG Modules", draft-ietf-netmod-iana-if-type-06 (work in + progress), April 2013. + + [I-D.ietf-netmod-rfc6021-bis] + Schoenwaelder, J., "Common YANG Data Types", + draft-ietf-netmod-rfc6021-bis-02 (work in progress), + May 2013. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group MIB", RFC 2863, June 2000. [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. @@ -977,45 +1151,47 @@ Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. Bierman, "Network Configuration Protocol (NETCONF)", RFC 6241, June 2011. [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, June 2011. + [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration + Protocol (NETCONF) Access Control Model", RFC 6536, + March 2012. + Appendix A. Example: Ethernet Interface Module This section gives a simple example of how an Ethernet interface module could be defined. It demonstrates how media-specific configuration parameters can be conditionally augmented to the - generic interface list. It is not intended as a complete module for + generic interface list. It also shows how operational state + parameters can be conditionally augmented to the operational + interface list. The example is not intended as a complete module for ethernet configuration. module ex-ethernet { namespace "http://example.com/ethernet"; prefix "eth"; import ietf-interfaces { prefix if; } + // configuration parameters for ethernet interfaces augment "/if:interfaces/if:interface" { when "if:type = 'ethernetCsmacd'"; container ethernet { - must "../if:location" { - description - "An ethernet interface must specify the physical location - of the ethernet hardware."; - } choice transmission-params { case auto { leaf auto-negotiate { type empty; } } case manual { leaf duplex { type enumeration { enum "half"; @@ -1027,20 +1203,36 @@ enum "10Mb"; enum "100Mb"; enum "1Gb"; enum "10Gb"; } } } } // other ethernet specific params... } + + } + + // operational state parameters for ethernet interfaces + augment "/if:interfaces-state/if:interface" { + when "if:type = 'ethernetCsmacd'"; + + container ethernet { + leaf duplex { + type enumeration { + enum "half"; + enum "full"; + } + } + // other ethernet specific params... + } } } Appendix B. Example: Ethernet Bonding Interface Module This section gives an example of how interface layering can be defined. An ethernet bonding interface is defined, which bonds several ethernet interfaces into one logical interface. module ex-ethernet-bonding { @@ -1121,303 +1313,402 @@ Appendix D. Example: NETCONF reply This section gives an example of a reply to the NETCONF request for a device that implements the example data models above. + + eth0 ethernetCsmacd - 0 - true - 2 + false + eth1 ethernetCsmacd - 1 true - 7 true + eth1.10 l2vlan true - 9 eth1 10 + + + lo1 + softwareLoopback + true + + + + + + + eth0 + ethernetCsmacd + down + down + 2 + 00:01:02:03:04:05 + + 2013-04-01T03:00:00Z + + + + + + eth1 + ethernetCsmacd + up + up + 7 + 00:01:02:03:04:06 + eth1.10 + + 2013-04-01T03:00:00Z + + + + + + eth1.10 + l2vlan + up + up + 9 + eth1 + + 2013-04-01T03:00:00Z + + + + + + + eth2 + ethernetCsmacd + down + down + 8 + 00:01:02:03:04:07 + + 2013-04-01T03:00:00Z + + + + + + lo1 + softwareLoopback + up + up + 1 + + 2013-04-01T03:00:00Z + + + + + Appendix E. Examples: Interface Naming Schemes This section gives examples of some implementation strategies. + The examples make use of the example data model "ex-vlan" (see + Appendix C) to show how logical interfaces can be configured. + E.1. Router with Restricted Interface Names In this example, a router has support for 4 line cards, each with 8 ports. The slots for the cards are physically numbered from 0 to 3, and the ports on each card from 0 to 7. Each card has fast- or gigabit-ethernet ports. - The implementation restricts the names of the interfaces to one of - "fastethernet-N/M" or "gigabitethernet-N/M". The "location" of an - interface is a string on the form "N/M". The implementation auto- - initializes the values for "type" and "location" based on the + The device-specific names for these physical interfaces are + "fastethernet-N/M" or "gigabitethernet-N/M". + + The name of a vlan interface is restricted to the form + ".". + + It is assumed that the operator is aware of this naming scheme. The + implementation auto-initializes the value for "type" based on the interface name. The NETCONF server does not advertise the 'arbitrary-names' feature in the message. - An operator can configure a new interface by sending an - containing: + An operator can configure a physical interface by sending an + containing: fastethernet-1/0 When the server processes this request, it will set the leaf "type" - to "ethernetCsmacd" and "location" to "1/0". Thus, if the client - performs a right after the above, it will - get: + to "ethernetCsmacd". Thus, if the client performs a + right after the above, it will get: fastethernet-1/0 ethernetCsmacd - 1/0 - If the client tries to change the location of this interface with an - containing: + The client can configure a vlan interface by sending an + containing: + + + fastethernet-1/0.10005 + l2-vlan + fastethernet-1/0 + 5 + + + If the client tries to change the type of the physical interface with + an containing: fastethernet-1/0 - 1/1 + tunnel then the server will reply with an "invalid-value" error, since the - new location does not match the name. + new type does not match the name. E.2. Router with Arbitrary Interface Names In this example, a router has support for 4 line cards, each with 8 ports. The slots for the cards are physically numbered from 0 to 3, and the ports on each card from 0 to 7. Each card has fast- or gigabit-ethernet ports. - The implementation does not restrict the interface names. This - allows to more easily apply the interface configuration to a - different physical interface. However, the additional level of - indirection also makes it a bit more complex to map interface names - found in other protocols to configuration entries. The "location" of - an interface is a string on the form "N/M". + The device-specific names for these physical interfaces are + "fastethernet-N/M" or "gigabitethernet-N/M". + + The implementation does not restrict the logical interface names. + This allows to more easily apply the interface configuration to a + different interface. However, the additional level of indirection + also makes it a bit more complex to map interface names found in + other protocols to configuration entries. The NETCONF server advertises the 'arbitrary-names' feature in the message. - An operator can configure a new interface by sending an - containing: + Physical interfaces are configured as in Appendix E.1. + + An operator can configure a logical interface by sending an + containing: acme-interface - ethernetCsmacd - 1/0 + l2-vlan + fastethernet-1/0 + 5 If necessary, the operator can move the configuration named "acme-interface" over to a different physical interface with an containing: acme-interface - 2/4 + fastethernet-1/1 E.3. Ethernet Switch with Restricted Interface Names In this example, an ethernet switch has a number of ports, each port identified by a simple port number. - The implementation restricts the interface names to numbers that - match the physical port number. - - The NETCONF server does not advertise the 'arbitrary-names' feature - in the message. + The device-specific names for the physical interfaces are numbers + that match the physical port number. - An operator can configure a new interface by sending an - containing: + An operator can configure a physical interface by sending an + containing: 6 When the server processes this request, it will set the leaf "type" - to "ethernetCsmacd" and "location" to "6". Thus, if the client - performs a right after the above, it will - get: + to "ethernetCsmacd". Thus, if the client performs a + right after the above, it will get: 6 ethernetCsmacd - 6 - If the client tries to change the location of this interface with an - containing: - - - 6 - 5 - - - then the server will reply with an "invalid-value" error, since the - new location does not match the name. - E.4. Generic Host with Restricted Interface Names - In this example, a generic host has interfaces named by the kernel - and without easily usable location information. The system - identifies the physical interface by the name assigned by the - operating system to the interface. + In this example, a generic host has interfaces named by the kernel. + The system identifies the physical interface by the name assigned by + the operating system to the interface. - The implementation restricts the interface name to the operating - system level name of the physical interface. + The name of a vlan interface is restricted to the form + ":". The NETCONF server does not advertise the 'arbitrary-names' feature in the message. - An operator can configure a new interface by sending an + An operator can configure an interface by sending an containing: eth8 When the server processes this request, it will set the leaf "type" - to "ethernetCsmacd" and "location" to "eth8". Thus, if the client - performs a right after the above, it will - get: + to "ethernetCsmacd". Thus, if the client performs a + right after the above, it will get: eth8 ethernetCsmacd - eth8 - If the client tries to change the location of this interface with an - containing: + The client can configure a vlan interface by sending an + containing: - - eth8 - eth7 + + eth8:5 + l2-vlan + eth8 + 5 - then the server will reply with an "invalid-value" error, since the - new location does not match the name. - E.5. Generic Host with Arbitrary Interface Names - In this example, a generic host has interfaces named by the kernel - and without easily usable location information. The system - identifies the physical interface by the name assigned by the - operating system to the interface. + In this example, a generic host has interfaces named by the kernel. + The system identifies the physical interface by the name assigned by + the operating system to the interface. - The implementation does not restrict the interface name to the - operating system level name of the physical interface. This allows - to more easily apply the interface configuration to a different - physical interface. However, the additional level of indirection + The implementation does not restrict the logical interface names. + This allows to more easily apply the interface configuration to a + different interface. However, the additional level of indirection also makes it a bit more complex to map interface names found in other protocols to configuration entries. The NETCONF server advertises the 'arbitrary-names' feature in the message. - An operator can configure a new interface by sending an - containing: + Physical interfaces are configured as in Appendix E.4. + + An operator can configure a logical interface by sending an + containing: acme-interface - ethernetCsmacd - eth4 + l2-vlan + eth8 + 5 + If necessary, the operator can move the configuration named "acme-interface" over to a different physical interface with an containing: acme-interface - eth3 + eth3 Appendix F. ChangeLog RFC Editor: remove this section upon publication as an RFC. -F.1. Version -08 +F.1. Version -11 + + o Separated the operational state from the configuration. + + o Removed 'location', and instead use the name to identify physical + interfaces. + + o Added the feature 'pre-provisioning'. + + o Made 'oper-status' and 'if-index' mandatory in the data model. + + o Added 'admin-status'. + + o Clarified why description can be mapped to ifAlias. + + o Clarified that 64-bit counters only are used, where there exist + 64-bit and 32-bit counters in IF-MIB. + + o Updated Security Considerations section with a reference to NACM. + +F.2. Version -08 o Removed the mtu leaf. o Added examples of different interface naming schemes. -F.2. Version -07 +F.3. Version -07 o Made leaf speed config false. -F.3. Version -06 +F.4. Version -06 o Added oper-status leaf. o Added leaf-lists higher-layer-if and lower-layer-if, that show the interface layering. o Added container statistics with counters. -F.4. Version -05 +F.5. Version -05 o Added an Informative References section. o Updated the Security Considerations section. o Clarified the behavior of an NETCONF server when invalid values are received. -F.5. Version -04 +F.6. Version -04 o Clarified why ifPromiscuousMode is not part of this data model. o Added a table that shows the mapping between this YANG data model and IF-MIB. -F.6. Version -03 +F.7. Version -03 o Added the section Relationship to the IF-MIB. o Changed if-index to be a leaf instead of leaf-list. o Explained the notation used in the data model tree picture. -F.7. Version -02 +F.8. Version -02 o Editorial fixes -F.8. Version -01 +F.9. Version -01 o Changed leaf "if-admin-status" to leaf "enabled". o Added Security Considerations Author's Address Martin Bjorklund Tail-f Systems