< draft-ietf-rtgwg-arp-yang-model-01.txt   draft-ietf-rtgwg-arp-yang-model-02.txt >
RTGWG F. Zheng RTGWG F. Zheng
Internet-Draft B. Wu Internet-Draft B. Wu
Intended status: Standards Track Huawei Intended status: Standards Track Huawei
Expires: February 25, 2019 R. Wilton Expires: September 11, 2019 R. Wilton
Cisco Systems Cisco Systems
X. Ding X. Ding
August 24, 2018 March 10, 2019
YANG Data Model for ARP YANG Data Model for ARP
draft-ietf-rtgwg-arp-yang-model-01 draft-ietf-rtgwg-arp-yang-model-02
Abstract Abstract
This document defines a YANG data model for the management of the This document defines a YANG data model for the management of the
Address Resolution Protocol (ARP). It extends the basic ARP Address Resolution Protocol (ARP). It extends the basic ARP
functionality contained in the ietf-ip YANG data model, defined in functionality contained in the ietf-ip YANG data model, defined in
RFC 8344, to provide management of optional ARP features and RFC 8344, to provide management of optional ARP features and
statistics. statistics.
The YANG data model in this document conforms to the Network The YANG data model in this document conforms to the Network
skipping to change at page 1, line 40 skipping to change at page 1, line 40
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 https://datatracker.ietf.org/drafts/current/. Drafts is at https://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 February 25, 2019. This Internet-Draft will expire on September 11, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2019 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
(https://trustee.ietf.org/license-info) in effect on the date of (https://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 . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4 1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4
2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4 2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 4
3. Design of the Data Model . . . . . . . . . . . . . . . . . . 4 3. Design of the Data Model . . . . . . . . . . . . . . . . . . 4
3.1. ARP dynamic learning . . . . . . . . . . . . . . . . . . 4 3.1. ARP Dynamic Learning . . . . . . . . . . . . . . . . . . 4
3.2. proxy ARP . . . . . . . . . . . . . . . . . . . . . . . . 5 3.2. Proxy ARP . . . . . . . . . . . . . . . . . . . . . . . . 5
3.3. gratuitous ARP . . . . . . . . . . . . . . . . . . . . . 5 3.3. Gratuitous ARP . . . . . . . . . . . . . . . . . . . . . 5
3.4. ietf-arp Module . . . . . . . . . . . . . . . . . . . . . 5 3.4. ARP Data Model . . . . . . . . . . . . . . . . . . . . . 5
4. ARP YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6 4. ARP YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6
5. Data Model Examples . . . . . . . . . . . . . . . . . . . . . 12 5. Data Model Examples . . . . . . . . . . . . . . . . . . . . . 11
5.1. Static ARP Entries . . . . . . . . . . . . . . . . . . . 12 5.1. Static ARP Entries . . . . . . . . . . . . . . . . . . . 11
5.2. ARP Dynamic Learning . . . . . . . . . . . . . . . . . . 13 5.2. ARP Dynamic Learning . . . . . . . . . . . . . . . . . . 12
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 14 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
7. Security Considerations . . . . . . . . . . . . . . . . . . . 14 7. Security Considerations . . . . . . . . . . . . . . . . . . . 12
8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 15 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 13
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 15 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
9.1. Normative References . . . . . . . . . . . . . . . . . . 15 9.1. Normative References . . . . . . . . . . . . . . . . . . 13
9.2. Informative References . . . . . . . . . . . . . . . . . 16 9.2. Informative References . . . . . . . . . . . . . . . . . 15
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 16 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15
1. Introduction 1. Introduction
This document defines a YANG [RFC7950] data model for the Address Basic ARP functionality is supported by the ietf-ip YANG data model,
Resolution Protocol [RFC0826] implementation and identification of defined in [RFC8344]. This document defines a YANG [RFC7950] data
some common properties within a device. Devices have common model that extends the basic ARP YANG support to also cover optional
properties that need to be configured and monitored in a standard ARP features, and ARP related statistics to aid network monitoring
way. This document is intended to present universal ARP protocol and troubleshooting.
configuration and many vendors can implement it.
The data model convers configuration of system parameters of ARP, This model defines YANG configuration and operational state data
such as static ARP entries, timeout for dynamic ARP entries, nodes both for ARP related functionality formally specified in other
interface ARP, proxy ARP, and so on. It also provides information RFCs (such as [RFC8344] and [RFC1027]), but also for common ARP
about running state of ARP implementations. behaviour that is often supported on network devices.
Where necessary, the expected behaviour of the YANG data nodes is
defined in the YANG model, and this document.
The YANG modules in this document conform to the Network Management The YANG modules in this document conform to the Network Management
Datastore Architecture (NMDA) [RFC8342]. Datastore Architecture (NMDA) [RFC8342].
Editorial Note: (To be removed by RFC Editor) Editorial Note: (To be removed by RFC Editor)
This draft contains many placeholder values that need to be replaced
with finalized values at the time of publication. Please apply the This draft contains several placeholder values that need to be
following replacements replaced with finalized values at the time of publication. Please
apply the following replacements:
o "XXXX" --> the assigned RFC value for this draft both in this o "XXXX" --> the assigned RFC value for this draft both in this
draft and in the YANG models under the revision statement. draft and in the YANG models under the revision statement.
o Revision date in model, in the format 2018-08-01 needs to get o The "revision" date in model, in the format XXXX-XX-XX, needs to
updated with the date the draft gets approved. The date also be updated with the date the draft gets approved. The date also
needs to get reflected on the line with <CODE BEGINS>. needs to get reflected on the line with <CODE BEGINS>.
1.1. Terminology 1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "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 "OPTIONAL" in this document are to be interpreted as described in
[BCP 14] [RFC2119] [RFC8174] when, and only when, they appear in all [BCP 14] [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
skipping to change at page 4, line 14 skipping to change at page 4, line 14
The terminology for describing YANG data models is found in The terminology for describing YANG data models is found in
[RFC7950]. [RFC7950].
1.2. Tree Diagrams 1.2. Tree Diagrams
Tree diagrams used in this document follow the notation defined in Tree diagrams used in this document follow the notation defined in
[RFC8340] [RFC8340]
2. Problem Statement 2. Problem Statement
This document defines a YANG [RFC7950] configuration data model that Neither ARP [RFC0826], nor Proxy-ARP [RFC1027], define standard
may be used to configure the ARP feature running on a system. Data network management configuration models. Instead, network equipment
model "ietf-ip" [RFC8344] covers the address mapping functionality. vendors have implemented their own bespoke configuration interfaces
However, this functionality is strictly dependent on IPv4 networks, and models.
and many ARP related functionalities are missing, e.g. device global
ARP entries and control, configuration related to dynamic ARP
learning, proxy ARP, gratuitous ARP, etc.
The data model makes use of the YANG "feature" construct which allows Network operators benefit from having common network management
implementations to support only those ARP features that lie within models defined that can be implemented by multiple network equipment
their capabilities. It is intended this model be used by service manufacturers. This simplifies the operation and management of
providers who manipulate devices from different vendors in a standard network devices.
way.
This model can be used to configure the ARP applications for Some, but not all, required ARP functionality has been defined in
discovering the link layer address associated with a given Internet ietf-ip.yang ([RFC8344]). Providing a standard YANG model that
layer address. models these optional ARP features, that are fairly widely
implemented by network equipment manufacturers , and used by network
operators, is beneficial to the general goal of interoperability in
the networking industry.
3. Design of the Data Model 3. Design of the Data Model
This data model intends to describe the processing that a protocol This data model intends to describe the processing that a protocol
finds the hardware address, also known as Media Access Control (MAC) finds the hardware address, also known as Media Access Control (MAC)
address, of a host from its known IP address. These tasks include, address, of a host from its known IP address. These tasks include,
but are not limited to, adding a static entry in the ARP cache, but are not limited to, configuring dynamic ARP learning, proxy ARP,
configuring dynamic ARP learning, proxy ARP, gratuitous ARP. There gratuitous ARP. There are two kind of ARP configurations: global ARP
are two kind of ARP configurations: global ARP configuration, which configuration, which is across all interfaces on the device, and per
is across all interfaces on the device, and per interface ARP interface ARP configuration.
configuration.
3.1. ARP dynamic learning 3.1. ARP Dynamic Learning
ARP caching is the method of storing network addresses and the As defined in [RFC0826], ARP caching is the method of storing network
associated data-link addresses in memory for a period of time as the addresses and the associated data-link addresses in memory for a
addresses are learned. This minimizes the use of valuable network period of time as the addresses are learned. This minimizes the use
resources to broadcast for the same address each time a datagram is of valuable network resources to broadcast for the same address each
sent. time a datagram is sent.
There are static ARP cache entries and dynamic ARP cache entries. There are static ARP cache entries and dynamic ARP cache entries.
Static entries are manually configured and kept in the cache table on Static entries, are manually configured and kept in the cache table
a permanent basis. Dynamic entries are added by vendor software, on a permanent basis which are defined in the ipv4 neighbor list for
kept for a period of time, and then removed. We can specify how long each interface in [RFC8344]. Dynamic entries are added by vendor
an entry remains in the ARP cache. If we specify a timeout of 0 software, kept for a period of time, and then removed. We can
seconds, entries are never cleared from the ARP cache. specify how long an entry remains in the ARP cache. If we specify a
timeout of 0 seconds, entries are never cleared from the ARP cache.
3.2. proxy ARP 3.2. Proxy ARP
Proxy ARP [RFC1027] can be configured to enable the switch to respond Proxy ARP, defined in [RFC1027], allows a router to respond to ARP
to ARP queries for network addresses by offering its own Ethernet requests on behalf of another machine that is not on the same local
media access control (MAC) address. With proxy ARP enabled, the subnet, offering its own Ethernet media access control (MAC) address.
switch captures and routes traffic to the intended destination. By replying in such a way, the router then takes responsibility for
routing packets to the intended destination.
3.3. gratuitous ARP In the case of certain data center network virtualization, as
specified in [RFC8014], the proxy ARP can be extended to intercept
all ARP requests, including source and target IP addresses in
different subnets, and those ARP requests in the same subnet to
suppress ARP handling.
Gratuitous ARP requests help detect duplicate IP addresses. A 3.3. Gratuitous ARP
gratuitous ARP is a broadcast request for a router's own IP address.
If a router or switch sends an ARP request for its own IP address and
no ARP replies are received, the router- or switch-assigned IP
address is not being used by other nodes. However, if a router or
switch sends an ARP request for its own IP address and an ARP reply
is received, the router- or switch-assigned IP address is already
being used by another node.
3.4. ietf-arp Module Gratuitous ARP enables a device to send an ARP Request packet using
its own IP address as the destination address. Gratuitous ARP
provides the following functions:
This module has one top level container, ARP, which consists of two o Checks duplicate IP addresses: [RFC5227] uses gratuitous ARP to
second level containers, which are used for static entries help detect IP conflicts. When a device receives an ARP request
configuration and global parameters control. containing a source IP that matches its own, then it knows there
is an IP conflict.
o Advertises a new MAC address: Also in RFC 5227, if the MAC address
of a host changes because its network adapter is replaced, the
host sends a gratuitous ARP packet to notify all hosts of the
change before the ARP entry is aged out.
o Notifies an active/standby switchover in a [RFC5798] VRRP backup
group: After an active/standby switchover, the master router sends
a gratuitous ARP packet in the VRRP backup group to notify the
switchover.
3.4. ARP Data Model
This document defines the YANG module "ietf-arp", which has the
following structure:
module: ietf-arp module: ietf-arp
+--rw arp +--rw arp
+--rw dynamic-learning? boolean +--rw dynamic-learning? boolean
+--rw proxy-arp? boolean
+--rw global-static-entries {global-static-entries}?
+--rw static-entry* [ip-address]
+--rw ip-address inet:ipv4-address-no-zone
+--rw mac-address yang:mac-address
augment /if:interfaces/if:interface: augment /if:interfaces/if:interface/ip:ipv4:
+--rw arp +--rw arp
+--rw expiry-time? uint32 +--rw expiry-time? uint32
+--rw learn-disable? boolean +--rw dynamic-learning? boolean
+--rw proxy +--rw proxy-arp
| +--rw mode? enumeration | +--rw mode? enumeration
+--rw probe +--rw gratuitous-arp
| +--rw interval? uint8
| +--rw times? uint8
| +--rw unicast? boolean
+--rw gratuitous
| +--rw enable? boolean | +--rw enable? boolean
| +--rw interval? uint32 | +--rw interval? uint32
| +--rw drop? boolean
+--ro statistics +--ro statistics
+--ro discontinuity-time? yang:date-and-time
+--ro in-requests-pkts? yang:counter32 +--ro in-requests-pkts? yang:counter32
+--ro in-replies-pkts? yang:counter32 +--ro in-replies-pkts? yang:counter32
+--ro in-gratuitous-pkts? yang:counter32 +--ro in-gratuitous-pkts? yang:counter32
+--ro out-requests-pkts? yang:counter32 +--ro out-requests-pkts? yang:counter32
+--ro out-replies-pkts? yang:counter32 +--ro out-replies-pkts? yang:counter32
+--ro out-gratuitous-pkts? yang:counter32 +--ro out-gratuitous-pkts? yang:counter32
augment /if:interfaces/if:interface/ip:ipv4/ip:neighbor: augment /if:interfaces/if:interface/ip:ipv4/ip:neighbor:
+--ro remaining-expiry-time? uint32 +--ro remaining-expiry-time? uint32
4. ARP YANG Module 4. ARP YANG Module
This section presents the ARP YANG module defined in this document. This section presents the ARP YANG module defined in this document.
This module imports definitions from Common YANG Data Types This module imports definitions from Common YANG Data Types
[RFC6991], A YANG Data Model for Interface Management [RFC8343], and [RFC6991], A YANG Data Model for Interface Management [RFC8343], and
A YANG Data Model for IP Management [RFC8344]. A YANG Data Model for IP Management [RFC8344].
<CODE BEGINS>file "ietf-arp@2018-08-01.yang" <CODE BEGINS> file "ietf-arp@2019-02-21.yang"
module ietf-arp {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-arp";
prefix arp;
import ietf-inet-types { module ietf-arp {
prefix inet; yang-version 1.1;
reference "RFC 6991: Common YANG Data Types"; namespace "urn:ietf:params:xml:ns:yang:ietf-arp";
} prefix arp;
import ietf-yang-types {
prefix yang;
reference "RFC 6991: Common YANG Data Types";
}
import ietf-interfaces {
prefix if;
reference "RFC 8343: A Yang Data Model for Interface Management";
}
import ietf-ip {
prefix ip;
reference "RFC 8344: A Yang Data Model for IP Management";
}
organization import ietf-yang-types {
"IETF Routing Area Working Group (rtgwg)"; prefix yang;
contact reference "RFC 6991: Common YANG Data Types";
"WG Web: <http://tools.ietf.org/wg/rtgwg/> }
WG List: <mailto: rtgwg@ietf.org> import ietf-interfaces {
Editor: Xiaojian Ding prefix if;
wjswsl@163.com reference "RFC 8343: A Yang Data Model for Interface Management";
Editor: Feng Zheng }
habby.zheng@huawei.com import ietf-ip {
Editor: Robert Wilton prefix ip;
rwilton@cisco.com"; reference "RFC 8344: A Yang Data Model for IP Management";
}
description organization
"Address Resolution Protocol (ARP) management, which includes "IETF Routing Area Working Group (rtgwg)";
static ARP configuration, dynamic ARP learning, ARP entry query, contact
and packet statistics collection. "WG Web: <http://tools.ietf.org/wg/rtgwg/>
WG List: <mailto: rtgwg@ietf.org>
Editor: Feng Zheng
habby.zheng@huawei.com
Editor: Bo Wu
lana.wubo@huawei.com
Editor: Robert Wilton
rwilton@cisco.com
Editor: Xiaojian Ding
wjswsl@163.com";
description
"Address Resolution Protocol (ARP) management, which includes
static ARP configuration, dynamic ARP learning, ARP entry query,
and packet statistics collection.
Copyright (c) 2016 IETF Trust and the persons identified as Copyright (c) 2018 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 the RFC This version of this YANG module is part of RFC XXXX; see the RFC
itself for full legal notices."; itself for full legal notices.";
revision 2018-08-01 { revision 2019-02-21 {
description description
"Init revision"; "Init revision";
reference "RFC XXXX: A Yang Data Model for ARP"; reference "RFC XXXX: A Yang Data Model for ARP";
} }
feature global-static-entries { container arp {
description description
"This feature indicates that the device allows static entries "Address Resolution Protocol (ARP)";
to be configured globally."; leaf dynamic-learning {
} type boolean;
default "true";
description
"Controls the default ARP learning behavior on all
interfaces on the device, unless explicit overridden by
the per-interface dynamic-learning leaf:
true - dynamic learning is enabled on all interfaces by
default,
false - dynamic learning is disabled on all interfaces by
default";
reference "RFC826: An Ethernet Address Resolution Protocol";
}
}
augment "/if:interfaces/if:interface/ip:ipv4" {
description
"Augment interfaces with ARP configuration and state.";
container arp {
description
"Address Resolution Protocol (ARP) related configuration
and state";
leaf expiry-time {
type uint32 {
range "30..86400";
}
units "seconds";
description
"Aging time of a received dynamic ARP entry before it is
removed from the cache.";
}
leaf dynamic-learning {
type boolean;
description
"Controls whether dynamic ARP learning is enabled on the
interface. If not configured, it defaults to the behavior
specified in the per-device /arp/dynamic-learning leaf.
container arp { true - dynamic learning is enabled
description false - dynamic learning is disabled";
"Address Resolution Protocol (ARP) management, which includes }
static ARP configuration, dynamic ARP learning, ARP entry container proxy-arp {
query, and packet statistics collection."; description
leaf dynamic-learning { "Configuration parameters for proxy ARP";
type boolean; leaf mode {
default "true"; type enumeration {
description enum disabled {
"Controls the default dynamic ARP learning behavior on all description
interfaces on the device: "The system only responds to ARP requests that
true - dynamic learning is enabled on all interfaces by specify a target address configured on the local
default, interface.";
false - dynamic learning is disabled on all interfaces by }
default"; enum remote-only {
} description
leaf proxy-arp { "The system responds to ARP requests only when the
type boolean; sender and target IP addresses are in different
default "true"; subnets.";
description }
"Controls the default proxy ARP behavior on all interfaces enum all {
on the device: description
true - proxy ARP is enabled on interfaces by default, "The system responds to ARP requests where the sender
false - proxy APR is disabled on interfaces by default"; and target IP addresses are in different subnets, as
} well as those where they are in the same subnet.";
container global-static-entries { }
if-feature "global-static-entries"; }
description default "disabled";
"Set a global static ARP entry, which is independent of the description
interface."; "When set to a value other than 'disable', the local
list static-entry { system should respond to ARP requests that are for
key "ip-address"; target addresses other than those that are configured on
description the local subinterface using its own MAC address as the
"List of ARP static entries that can be configured target hardware address. If the 'remote-only' value is
globally."; specified, replies are only sent when the target address
leaf ip-address { falls outside the locally configured subnets on the
type inet:ipv4-address-no-zone; interface, whereas with the 'all' value, all requests,
description regardless of their target address are replied to.";
"IP address, in dotted decimal notation."; reference
} "RFC1027: Using ARP to Implement Transparent Subnet
leaf mac-address { Gateways";
type yang:mac-address; }
mandatory true; }
description container gratuitous-arp {
"MAC address in the format of H-H-H, in which H is a description "Configure gratuitous ARP.";
hexadecimal number of 1 to 4 bits."; reference "RFC5227: IPv4 Address Conflict Detection";
} leaf enable {
} type boolean;
} description
} "Enable or disable sending gratuitous ARP packet on the
augment "/if:interfaces/if:interface" { interface. The default behaviour is device specific";
description }
"Augment interfaces with ARP configuration and state."; leaf interval {
container arp { type uint32 {
description range "1..86400";
"Dynamic ARP related configuration and state"; }
leaf expiry-time { units "seconds";
type uint32 { description
range "60..86400"; "The interval, in seconds, between sending gratuitous ARP
} packet on the interface.";
units "seconds"; }
description }
"Aging time of a dynamic ARP entry."; container statistics {
} config false;
leaf learn-disable { description
type boolean; "ARP per-interface packet statistics
default "false";
description For all ARP counters, discontinuities in the value can
"Whether dynamic ARP learning is disabled on an interface: occur at re-initialization of the management system and at
If the value is True, dynamic ARP learning is disabled. other times as indicated by the value of
If the value is False, dynamic ARP learning is enabled."; 'discontinuity-time'.";
}
container proxy { leaf discontinuity-time {
description type yang:date-and-time;
"Configuration parameters for proxy ARP"; description
leaf mode { "The time on the most recent occasion at which any one or
type enumeration { more of this interface's ARP counters suffered a
enum DISABLE { discontinuity. If no such discontinuities have occurred
description since the last re-initialization of the local management
"The system should not respond to ARP requests that subsystem, then this node contains the time the local
do not specify an IP address configured on the local management subsystem re-initialized itself.";
subinterface as the target address."; }
}
enum REMOTE_ONLY { leaf in-requests-pkts {
description type yang:counter32;
"The system responds to ARP requests only when the description
sender and target IP addresses are in different "The number of ARP request packets received on this
subnets."; interface.";
} }
enum ALL {
description leaf in-replies-pkts {
"The system responds to ARP requests where the sender type yang:counter32;
and target IP addresses are in different subnets, as description
well as those where they are in the same subnet."; "The number of ARP reply packets received on this
} interface.";
} }
default "DISABLE"; leaf in-gratuitous-pkts {
description type yang:counter32;
"When set to a value other than DISABLE, the local system description
should respond to ARP requests that are for target "The number of gratuitous ARP packets received on this
addresses other than those that are configured on the interface.";
local subinterface using its own MAC address as the }
target hardware address. If the REMOTE_ONLY value is leaf out-requests-pkts {
specified, replies are only sent when the target address type yang:counter32;
falls outside the locally configured subnets on the description
interface, whereas with the ALL value, all requests, "The number of ARP request packets sent on this interface.";
regardless of their target address are replied to."; }
reference leaf out-replies-pkts {
"RFC1027: Using ARP to Implement Transparent Subnet type yang:counter32;
Gateways"; description
} "The number of ARP reply packets sent on this interface.";
}
container probe { }
description leaf out-gratuitous-pkts {
"Common configuration parameters for all ARP probe."; type yang:counter32;
leaf interval { description
type uint8 { "The number of gratuitous ARP packets sent on this
range "1..5"; interface.";
} }
units "second"; }
description }
"Interval for detecting dynamic ARP entries."; }
}
leaf times { augment "/if:interfaces/if:interface/ip:ipv4/ip:neighbor" {
type uint8 { description
range "0..10"; "Augment IPv4 neighbor list with ARP expiry time.";
} leaf remaining-expiry-time {
description type uint32;
"Number of aging probe attempts for a dynamic ARP entry. units "seconds";
If a device does not receive an ARP reply message after config false;
the number of aging probe attempts reaches a specified description
number,thedynamic ARP entry is deleted."; "The number of seconds until the dynamic ARP entry expires and is
} removed from the ARP cache";
leaf unicast { }
type boolean; }
default "false"; }
description
"Send unicast ARP aging probe messages for a dynamic ARP
entry.";
}
}
container gratuitous-arp {
description
"Configure gratuitous ARP.";
leaf enable {
type boolean;
default "false";
description
"Enable or disable sending gratuitous ARP packet on
interface.";
}
leaf interval {
type uint32 {
range "1..86400";
}
units "second";
description
"The interval of sending gratuitous ARP packet on the
interface.";
}
leaf drop {
type boolean;
default "false";
description
"Drop the receipt of gratuitous ARP packets on the
interface.";
}
}
container statistics {
config false;
description
"IP ARP Statistics information on interfaces";
leaf in-requests-pkts {
type yang:counter32;
description
"Total ARP requests received";
}
leaf in-replies-pkts {
type yang:counter32;
description
"Total ARP replies received";
}
leaf in-gratuitous-pkts {
type yang:counter32;
description
"Total gratuitous ARP received";
}
leaf out-requests-pkts {
type yang:counter32;
description
"Total ARP requests sent";
}
leaf out-replies-pkts {
type yang:counter32;
description
"Total ARP replies sent";
}
leaf out-gratuitous-pkts {
type yang:counter32;
description
"Total gratuitous ARP sent";
}
}
}
}
augment "/if:interfaces/if:interface/ip:ipv4/ip:neighbor" {
description
"Augment neighbor list with parameters of ARP, eg., support for
remaining expiry time query on interfaces.";
leaf remaining-expiry-time {
type uint32;
config false;
description
"Remaining expiry time of a dynamic ARP entry. ";
}
}
}
5. Data Model Examples 5. Data Model Examples
This section presents a simple but complete example of configuring This section presents a simple example of configuring static ARP
static ARP entries and dynamic learning, based on the YANG modules entries and dynamic learning, based on the YANG modules specified in
specified in Section 4. Section 4.
5.1. Static ARP Entries 5.1. Static ARP Entries
Requirement:
Enable static ARP entry global configuration (not rely on interface).
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<arp xmlns="urn:ietf:params:xml:ns:yang:ietf-arp">
<static-tables>
<ip-address> 10.2.2.3 </ip-address>
<mac-address> 00e0-fc01-0000 </mac-address>
</static-tables>
</arp>
Requirement: Requirement: Enable static ARP entry configuration on interface
Enable static ARP entry configuration on interface (defined in (defined in [RFC8344] ).
draft [I-D.ietf-netmod-rfc7277bis]).
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<ipv4 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip"> <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
<ipv4 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip">
<neighbor> <neighbor>
<ip-address> 10.2.2.3 </ip-address> <ip-address>192.0.2.1</ip-address>
<mac-address> 00e0-fc01-0000 </mac-address> <link-layer-address>00e0-fc01-0000</link-layer-address>
<if-name> GE1/0/1 </if-name> <origin>static</origin>
</neighbor> </neighbor>
</ipv4> </ipv4>
</interfaces>
5.2. ARP Dynamic Learning 5.2. ARP Dynamic Learning
Requirement: Requirement: Disable ARP dynamic learning configuration.
Enable ARP dynamic learning configuration.
<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">
<arp xmlns="urn:ietf:params:xml:ns:yang:ietf-arp"> <arp xmlns="urn:ietf:params:xml:ns:yang:ietf-arp">
<if-name> GE1/0/1 </if-name> <dynamic-learning>false</dynamic-learning>
<expire-time>1200</expire-time> </arp>
<learn-disable>false</learn-disable> <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
<proxy-enable>false</proxy-enable> <interface>
<probe> <name>eth0</name>
<interval>5</interval> <arp>
<times>3</times> <expiry-time>1200</expiry-time>
<unicast>false</unicast> <dynamic-learning>false</dynamic-learning>
</probe> <proxy-arp>
<gratuitous> <mode>remote-only</mode>
<gratuitous-enable>false<gratuitous-enable> </proxy-arp>
<interval>60</interval> <gratuitous-arp>
<drop>false</drop> <enable>true<enable>
<gratuitous> <interval>60</interval>
</arp> </gratuitous-arp>
</arp>
</interface>
</interfaces>
6. IANA Considerations 6. IANA Considerations
This document registers a URI in theIETF XML registry [RFC3688]. This document registers a URI in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the following registration is Following the format in [RFC3688], the following registration is
requested to be made: requested to be made:
URI: urn:ietf:params:xml:ns:yang:ietf-arp URI: urn:ietf:params:xml:ns:yang:ietf-arp Registrant Contact:
Registrant Contact: The IESG. The IESG. 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 [RFC7950]. registry [RFC6020].
Name: ietf-arp Name: ietf-arp Namespace: urn:ietf:params:xml:ns:yang:
Namespace: urn:ietf:params:xml:ns:yang: ietf-arp ietf-arp Prefix: arp Reference: RFC XXXX
Prefix: arp
Reference: RFC XXXX
7. Security Considerations 7. Security Considerations
The YANG module defined in this document is designed to be accessed The YANG module specified in this document defines a schema for data
via YANG based management protocols, such as NETCONF [RFC6241] and that is designed to be accessed via network management protocols such
RESTCONF [RFC8040]. Both of these protocols have mandatory-to- as NETCONF [RFC6241] or RESTCONF [RFC8040] . The lowest NETCONF
implement secure transport layers (e.g., SSH, TLS) with mutual layer is the secure transport layer, and the mandatory-to-implement
authentication. secure transport is Secure Shell (SSH) [RFC6242]. The lowest
RESTCONF layer is HTTPS, and the mandatory-to-implement secure
transport is TLS [RFC8446].
The NETCONF access control model (NACM) [RFC8341] provides the means The NETCONF access control model [RFC8341] provides the means to
to restrict access for particular users to a pre-configured subset of restrict access for particular NETCONF or RESTCONF users to a
all available protocol operations and content. preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content..
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that 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)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. effect on network operations.These are the subtrees and data nodes
and their sensitivity/vulnerability:
These are the subtrees and data nodes and their sensitivity/
vulnerability:
arp/dynamic-learning: This leaf is used to enable ARP dynamic arp/dynamic-learning: This leaf is used to enable ARP dynamic
learning on all interfaces.ARP dynamic learning could allow an learning on all interfaces.ARP dynamic learning could allow an
attacker to inject spoofed traffic into the network, e.g. denial- attacker to inject spoofed traffic into the network, e.g. denial-
of- service attack. of- service attack.
arp/proxy-arp and arp/proxy:These leaves are used to enable ARP interface/ipv4/arp/proxy:These leaves are used to enable ARP proxy
proxy on interface. They could allow traffic to be mis-configured on interface. They could allow traffic to be mis-configured
(denial-of- service attack). (denial-of- service attack).
arp/global-static-entries/static-entry: This list specifies ARP interface/ipv4/arp/gratuitous-arp:This leaf is used to enable
static entries configured on the device. By modifying this sending gratuitous ARP packet on an interface.This configuration
information, an attacker can cause a node to either ignore could allow an attacker to inject spoofed traffic into the
messages destined to it or accept messages it would otherwise network, e.g. man-in-the-middle attack.
ignore.
/arp/gratuitous-arp:This leaf is used to enable sending gratuitous
ARP packet on an interface.This configuration could allow an
attacker to inject spoofed traffic into the network, e.g. man-in-
the-middle attack.
8. Acknowledgments 8. Acknowledgments
The authors wish to thank Alex Campbell and Reshad Rahman, Qin Wu, The authors wish to thank Alex Campbell and Reshad Rahman, Qin Wu,
Tom Petch, many others for their helpful comments. Tom Petch, many others for their helpful comments.
9. References 9. References
9.1. Normative References 9.1. Normative References
skipping to change at page 15, line 45 skipping to change at page 14, line 19
[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, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC5227] Cheshire, S., "IPv4 Address Conflict Detection", RFC 5227,
DOI 10.17487/RFC5227, July 2008,
<https://www.rfc-editor.org/info/rfc5227>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013, RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>. <https://www.rfc-editor.org/info/rfc6991>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
skipping to change at page 16, line 22 skipping to change at page 15, line 9
<https://www.rfc-editor.org/info/rfc8342>. <https://www.rfc-editor.org/info/rfc8342>.
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface [RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, Management", RFC 8343, DOI 10.17487/RFC8343, March 2018,
<https://www.rfc-editor.org/info/rfc8343>. <https://www.rfc-editor.org/info/rfc8343>.
[RFC8344] Bjorklund, M., "A YANG Data Model for IP Management", [RFC8344] Bjorklund, M., "A YANG Data Model for IP Management",
RFC 8344, DOI 10.17487/RFC8344, March 2018, RFC 8344, DOI 10.17487/RFC8344, March 2018,
<https://www.rfc-editor.org/info/rfc8344>. <https://www.rfc-editor.org/info/rfc8344>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
9.2. Informative References 9.2. Informative References
[RFC5798] Nadas, S., Ed., "Virtual Router Redundancy Protocol (VRRP)
Version 3 for IPv4 and IPv6", RFC 5798,
DOI 10.17487/RFC5798, March 2010,
<https://www.rfc-editor.org/info/rfc5798>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC8014] Black, D., Hudson, J., Kreeger, L., Lasserre, M., and T.
Narten, "An Architecture for Data-Center Network
Virtualization over Layer 3 (NVO3)", RFC 8014,
DOI 10.17487/RFC8014, December 2016,
<https://www.rfc-editor.org/info/rfc8014>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
 End of changes. 59 change blocks. 
446 lines changed or deleted 421 lines changed or added

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