1 module ietf-interfaces {
3 namespace "urn:ietf:params:xml:ns:yang:ietf-interfaces";
6 import ietf-yang-types {
8 revision-date 2010-09-24;
12 "IETF NETMOD (NETCONF Data Modeling Language) Working Group";
15 "WG Web: <http://tools.ietf.org/wg/netmod/>
16 WG List: <mailto:netmod@ietf.org>
18 WG Chair: David Kessens
19 <mailto:david.kessens@nsn.com>
21 WG Chair: Juergen Schoenwaelder
22 <mailto:j.schoenwaelder@jacobs-university.de>
24 Editor: Martin Bjorklund
25 <mailto:mbj@tail-f.com>";
28 "This module contains a collection of YANG definitions for
29 managing network interfaces.
31 Copyright (c) 2012 IETF Trust and the persons identified as
32 authors of the code. All rights reserved.
34 Redistribution and use in source and binary forms, with or
35 without modification, is permitted pursuant to, and subject
36 to the license terms contained in, the Simplified BSD License
37 set forth in Section 4.c of the IETF Trust's Legal Provisions
38 Relating to IETF Documents
39 (http://trustee.ietf.org/license-info).
41 This version of this YANG module is part of RFC XXXX; see
42 the RFC itself for full legal notices.";
44 // RFC Ed.: replace XXXX with actual RFC number and remove this
47 // RFC Ed.: update the date below with the date of RFC publication
48 // and remove this note.
53 "RFC XXXX: A YANG Data Model for Interface Management";
58 typedef interface-ref {
60 path "/if:interfaces/if:interface/if:name";
63 "This type is used by data models that need to reference
69 feature arbitrary-names {
71 "This feature indicates that the server allows interfaces to
72 be named arbitrarily.";
77 "This feature indicates that the server implements IF-MIB.";
79 "RFC 2863: The Interfaces Group MIB";
84 container interfaces {
86 "Interface parameters.";
93 "The list of interfaces on the device.";
98 "The name of the interface.
100 A device MAY restrict the allowed values for this leaf,
101 possibly depending on the type and location.
103 If the device allows arbitrarily named interfaces, the
104 feature 'arbitrary-names' is advertised.
106 This leaf MAY be mapped to ifName by an implementation.
107 Such an implementation MAY restrict the allowed values for
108 this leaf so that it matches the restrictions of ifName.
109 If a NETCONF server that implements this restriction is
110 sent a value that doesn't match the restriction, it MUST
111 reply with an rpc-error with the error-tag
114 "RFC 2863: The Interfaces Group MIB - ifName";
120 "A textual description of the interface.
122 This leaf MAY be mapped to ifAlias by an implementation.
123 Such an implementation MAY restrict the allowed values for
124 this leaf so that it matches the restrictions of ifAlias.
125 If a NETCONF server that implements this restriction is
126 sent a value that doesn't match the restriction, it MUST
127 reply with an rpc-error with the error-tag
130 "RFC 2863: The Interfaces Group MIB - ifAlias";
136 "The device-specific location of the interface of a
137 particular type. The format of the location string
138 depends on the interface type and the device.
140 If the interface's type represents a physical interface,
141 this leaf MUST be set.
143 When an interface entry is created, a server MAY
144 initialize the location leaf with a valid value, e.g., if
145 it is possible to derive the location from the name of
153 "The desired state of the interface.
155 This leaf contains the configured, desired state of the
156 interface. Systems that implement the IF-MIB use the
157 value of this leaf to set IF-MIB.ifAdminStatus to 'up' or
158 'down' after an ifEntry has been initialized, as described
161 "RFC 2863: The Interfaces Group MIB - ifAdminStatus";
165 type yang:date-and-time;
168 "The time the interface entered its current operational
169 state. If the current state was entered prior to the
170 last re-initialization of the local network management
171 subsystem, then this node is not present.";
173 "RFC 2863: The Interfaces Group MIB - ifLastChange";
179 range "1..2147483647";
183 "The ifIndex value for the ifEntry represented by this
186 Media-specific modules must specify how the type is
187 mapped to entries in the ifTable.";
189 "RFC 2863: The Interfaces Group MIB - ifIndex";
193 type yang:phys-address;
196 "The interface's address at its protocol sub-layer. For
197 example, for an 802.x interface, this object normally
198 contains a MAC address. The interface's media-specific
199 modules must define the bit and byte ordering and the
200 format of the value of this object. For interfaces that do
201 not have such an address (e.g., a serial line), this node
204 "RFC 2863: The Interfaces Group MIB - ifPhysAddress";
207 leaf-list higher-layer-if {
211 "A list of references to interfaces layered on top of this
214 "RFC 2863: The Interfaces Group MIB - ifStackTable";
217 leaf-list lower-layer-if {
221 "A list of references to interfaces layered underneath this
224 "RFC 2863: The Interfaces Group MIB - ifStackTable";
229 units "bits / second";
232 "An estimate of the interface's current bandwidth in bits
233 per second. For interfaces which do not vary in
234 bandwidth or for those where no accurate estimation can
235 be made, this node should contain the nominal bandwidth.
236 For interfaces that has no concept of bandwidth, this
237 node is not present.";
239 "RFC 2863: The Interfaces Group MIB -
240 ifSpeed, ifHighSpeed";
243 container statistics {
246 "A collection of interface-related statistics objects.";
248 leaf discontinuity-time {
249 type yang:date-and-time;
251 "The time on the most recent occasion at which any one or
252 more of this interface's counters suffered a
253 discontinuity. If no such discontinuities have occurred
254 since the last re-initialization of the local management
255 subsystem, then this node contains the time the local
256 management subsystem re-initialized itself.";
262 "The total number of octets received on the interface,
263 including framing characters.
265 Discontinuities in the value of this counter can occur
266 at re-initialization of the management system, and at
267 other times as indicated by the value of
268 'discontinuity-time'.";
270 "RFC 2863: The Interfaces Group MIB - ifHCInOctets";
272 leaf in-unicast-pkts {
275 "The number of packets, delivered by this sub-layer to a
276 higher (sub-)layer, which were not addressed to a
277 multicast or broadcast address at this sub-layer.
279 Discontinuities in the value of this counter can occur
280 at re-initialization of the management system, and at
281 other times as indicated by the value of
282 'discontinuity-time'.";
284 "RFC 2863: The Interfaces Group MIB - ifHCInUcastPkts";
286 leaf in-broadcast-pkts {
289 "The number of packets, delivered by this sub-layer to a
290 higher (sub-)layer, which were addressed to a broadcast
291 address at this sub-layer.
293 Discontinuities in the value of this counter can occur
294 at re-initialization of the management system, and at
295 other times as indicated by the value of
296 'discontinuity-time'.";
298 "RFC 2863: The Interfaces Group MIB -
299 ifHCInBroadcastPkts";
301 leaf in-multicast-pkts {
304 "The number of packets, delivered by this sub-layer to a
305 higher (sub-)layer, which were addressed to a multicast
306 address at this sub-layer. For a MAC layer protocol,
307 this includes both Group and Functional addresses.
309 Discontinuities in the value of this counter can occur
310 at re-initialization of the management system, and at
311 other times as indicated by the value of
312 'discontinuity-time'.";
314 "RFC 2863: The Interfaces Group MIB -
315 ifHCInMulticastPkts";
320 "The number of inbound packets which were chosen to be
321 discarded even though no errors had been detected to
322 prevent their being deliverable to a higher-layer
323 protocol. One possible reason for discarding such a
324 packet could be to free up buffer space.
326 Discontinuities in the value of this counter can occur
327 at re-initialization of the management system, and at
328 other times as indicated by the value of
329 'discontinuity-time'.";
331 "RFC 2863: The Interfaces Group MIB - ifInDiscards";
336 "For packet-oriented interfaces, the number of inbound
337 packets that contained errors preventing them from being
338 deliverable to a higher-layer protocol. For character-
339 oriented or fixed-length interfaces, the number of
340 inbound transmission units that contained errors
341 preventing them from being deliverable to a higher-layer
344 Discontinuities in the value of this counter can occur
345 at re-initialization of the management system, and at
346 other times as indicated by the value of
347 'discontinuity-time'.";
349 "RFC 2863: The Interfaces Group MIB - ifInErrors";
351 leaf in-unknown-protos {
354 "For packet-oriented interfaces, the number of packets
355 received via the interface which were discarded because
356 of an unknown or unsupported protocol. For
357 character-oriented or fixed-length interfaces that
358 support protocol multiplexing the number of transmission
359 units received via the interface which were discarded
360 because of an unknown or unsupported protocol. For any
361 interface that does not support protocol multiplexing,
362 this counter is not present.
364 Discontinuities in the value of this counter can occur
365 at re-initialization of the management system, and at
366 other times as indicated by the value of
367 'discontinuity-time'.";
369 "RFC 2863: The Interfaces Group MIB - ifInUnknownProtos";
375 "The total number of octets transmitted out of the
376 interface, including framing characters.
378 Discontinuities in the value of this counter can occur
379 at re-initialization of the management system, and at
380 other times as indicated by the value of
381 'discontinuity-time'.";
383 "RFC 2863: The Interfaces Group MIB - ifHCOutOctets";
385 leaf out-unicast-pkts {
388 "The total number of packets that higher-level protocols
389 requested be transmitted, and which were not addressed
390 to a multicast or broadcast address at this sub-layer,
391 including those that were discarded or not sent.
393 Discontinuities in the value of this counter can occur
394 at re-initialization of the management system, and at
395 other times as indicated by the value of
396 'discontinuity-time'.";
398 "RFC 2863: The Interfaces Group MIB - ifHCOutUcastPkts";
400 leaf out-broadcast-pkts {
403 "The total number of packets that higher-level protocols
404 requested be transmitted, and which were addressed to a
405 broadcast address at this sub-layer, including those
406 that were discarded or not sent.
408 Discontinuities in the value of this counter can occur
409 at re-initialization of the management system, and at
410 other times as indicated by the value of
411 'discontinuity-time'.";
413 "RFC 2863: The Interfaces Group MIB -
414 ifHCOutBroadcastPkts";
416 leaf out-multicast-pkts {
419 "The total number of packets that higher-level protocols
420 requested be transmitted, and which were addressed to a
421 multicast address at this sub-layer, including those
422 that were discarded or not sent. For a MAC layer
423 protocol, this includes both Group and Functional
426 Discontinuities in the value of this counter can occur
427 at re-initialization of the management system, and at
428 other times as indicated by the value of
429 'discontinuity-time'.";
431 "RFC 2863: The Interfaces Group MIB -
432 ifHCOutMulticastPkts";
437 "The number of outbound packets which were chosen to be
438 discarded even though no errors had been detected to
439 prevent their being transmitted. One possible reason
440 for discarding such a packet could be to free up buffer
443 Discontinuities in the value of this counter can occur
444 at re-initialization of the management system, and at
445 other times as indicated by the value of
446 'discontinuity-time'.";
448 "RFC 2863: The Interfaces Group MIB - ifOutDiscards";
453 "For packet-oriented interfaces, the number of outbound
454 packets that could not be transmitted because of errors.
455 For character-oriented or fixed-length interfaces, the
456 number of outbound transmission units that could not be
457 transmitted because of errors.
459 Discontinuities in the value of this counter can occur
460 at re-initialization of the management system, and at
461 other times as indicated by the value of
462 'discontinuity-time'.";
464 "RFC 2863: The Interfaces Group MIB - ifOutErrors";