One document matched: draft-cui-dhc-dhcpv6-yang-02.xml
<?xml version="1.0" encoding="US-ASCII"?>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
<?rfc strict="yes" ?>
<?rfc toc="yes"?>
<?rfc tocdepth="4"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes" ?>
<?rfc compact="yes" ?>
<?rfc subcompact="no" ?>
<rfc category="std" docName="draft-cui-dhc-dhcpv6-yang-02" ipr="trust200902">
<front>
<title abbrev="YANG for DHCPv6">YANG Data Model for DHCPv6 Configuration</title>
<author fullname="Yong Cui" initials="Y." surname="Cui">
<organization>Tsinghua University</organization>
<address>
<postal>
<street/>
<city>Beijing</city>
<code>100084</code>
<country>P.R.China</country>
</postal>
<phone>+86-10-6260-3059</phone>
<email>yong@csnet1.cs.tsinghua.edu.cn</email>
</address>
</author>
<author fullname="Hao Wang" initials="H." surname="Wang">
<organization>Tsinghua University</organization>
<address>
<postal>
<street/>
<city>Beijing</city>
<code>100084</code>
<country>P.R.China</country>
</postal>
<phone>+86-10-6278-5822</phone>
<email>wangh13@mails.tsinghua.edu.cn</email>
</address>
</author>
<author fullname="Linhui Sun" initials="L." surname="Sun">
<organization>Tsinghua University</organization>
<address>
<postal>
<street/>
<city>Beijing</city>
<code>100084</code>
<country>P.R.China</country>
</postal>
<phone>+86-10-6278-5822</phone>
<email>lh.sunlinh@gmail.com</email>
</address>
</author>
<author fullname="Ted Lemon" initials="T" surname="Lemon">
<organization abbrev="Nominum">Nominum, Inc.</organization>
<address>
<postal>
<street>950 Charter St.</street>
<city>Redwood City</city>
<region>CA</region>
<code>94043</code>
<country>USA</country>
</postal>
<email>Ted.Lemon@nominum.com</email>
</address>
</author>
<date year="2015" />
<workgroup>DHC Working Group</workgroup>
<abstract>
<t>There has no unified method to configure DHCPv6 server ,relay and
client itself, always pre-configured manually by operators.</t>
<t>IETF netmod WG has developed a general data model for NETCONF
protocol, YANG data model <xref target="RFC6020"></xref>.</t>
<t>This document defines a YANG data model for the configuration and
management of DHCPv6 server, DHCPv6 relay and DHCPv6 client. With
this model, the operators can configure and manage the devices by
using NETCONF.</t>
</abstract>
<note title="Requirements Language">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref
target="RFC2119"></xref>.</t>
</note>
</front>
<middle>
<section anchor="introduction" title="Introduction">
<t>This document defines a YANG data model for the configuration and
management of DHCPv6 server, DHCPv6 relay and DHCPv6 client. With this
model, the operators can configure and manage the devices by using NETCONF.</t>
<t>Model include three sub-modules:</t>
<t><list style="symbols">
<t>DHCPv6 server</t>
<t>DHCPv6 relay</t>
<t>DHCPv6 client</t>
</list></t>
<section anchor="terminology" title="Terminology">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref
target="RFC2119"></xref>.</t>
<t>The reader should be familiar with the terms defined in DHCPv6
<xref target="RFC3315"></xref> and relevant documents.</t>
<t>DHCPv6 tree diagrams provide a concise representation of a YANG
module to help readers understand the module structure. The meaning if the
symbols in these diagrams is as follows:</t>
<t><list style="symbols">
<t>Brackets "[" and "]" enclose list keys.</t>
<t>Braces "{" and "}" enclose feature content.</t>
<t>Parentheses "(" and ")" enclose choice and case nodes, and
case nodes are also marked with a colon (":").</t>
<t>Symbols after data node names: "?" means an optional node,
and "*" denotes a list and leaf-list.</t>
<t>Abbreviations before data node names: "rw" means
configuration data (read-write), and "ro" means state data
(read-only).</t></list>
</t>
</section>
</section>
<section anchor="objectives" title="Objectives">
<t>This document defines a YANG data model that can be used to configure
and manage DHCPv6 server, DHCPv6 relay and DHCPv6 client.</t>
<section anchor="dhcpv6server" title="DHCPv6 server">
<t>DHCPv6 server parameters.</t>
</section>
<section anchor="dhcpv6relay" title="DHCPv6 relay">
<t>DHCPv6 relay parameters.</t>
</section>
<section anchor="dhcpv6client" title="DHCPv6 client">
<t>DHCPv6 client parameters.</t>
</section>
</section>
<section anchor="tree-diagram" title="DHCPv6 Tree Diagrams">
<section anchor="dhcpv6-server-tree" title="DHCPv6 Server Tree Diagrams">
<figure align="center" anchor="structure" title="DHCPv6 Data Model Structure">
<artwork><![CDATA[
+--rw dhcpv6
+--rw server {dhcpv6-server}?
+--rw serv-attributes
| +--rw name string
| +--ro duid uint32
| +--rw enable boolean
| +--rw description? string
| +--rw pd-function boolean
| +--rw stateless-service boolean
| +--rw rapid-commit boolean
| +--ro vendor-info
| +--ro ent-num uint8
| +--ro data* string
+--rw address-pools
| +--rw address-pool* [pool-id]
| | +--rw pool-id uint8
| | +--rw pool-prefix inet:ipv6-prefix
| | +--rw start-address inet:ipv6-address-no-zone
| | +--rw end-address inet:ipv6-address-no-zone
| | +--rw preferred-lifetime yang:timeticks
| | +--rw valid-lifetime yang:timeticks
| | +--ro used-ipv6-count uint32
| | +--ro idle-ipv6-count uint32
| +--ro binding-info* [cli-duid]
| +--ro cli-duid uint32
| +--ro cli-ia* [iaid]
| +--ro ia-type string
| +--ro iaid uint8
| +--ro cli-addr* inet:ipv6-address
| +--ro pool-id? uint8
+--rw prefix-pools
| +--rw prefix-pool* [pool-id]
| | +--rw pool-id uint8
| | +--rw prefix inet:ipv6-prefix
| | +--rw prefix-length uint8
| | +--rw preferred-lifetime yang:timeticks
| | +--rw valid-lifetime yang:timeticks
| +--ro binding-info* [cli-duid]
| +--ro cli-duid uint32
| +--ro cli-iapd* [iaid]
| +--ro iaid uint8
| +--ro cli-prefix* inet:ipv6-prefix
| +--ro cli-prefix-len* uint8
| +--ro pool-id? uint8
+--rw other-paras
| +--rw dns-server* [dns-serv-id]
| | +--rw dns-serv-id uint8
| | +--rw dns-serv-addr inet:ipv6-address
| +--rw domain-search-list string
| +--rw sip-server* [sip-serv-id]
| | +--rw sip-serv-id uint8
| | +--rw sip-serv-domain-name string
| | +--rw sip-serv-addr inet:ipv6-address
| +--rw sntp-server* [sntp-serv-id]
| | +--rw sntp-serv-id uint8
| | +--rw sntp-serv-addr inet:ipv6-address
| +--rw ntp-serv-paras* [ntp-serv-id]
| | +--rw ntp-serv-id uint8
| | +--rw ntp-serv-addr inet:ipv6-address
| | +--rw ntp-serv-mul-addr inet:ipv6-address
| | +--rw ntp-serv-fqdn string
| +--rw nis-paras
| | +--rw nis-serv-addr inet:ipv6-address
| | +--rw nis-cli-info* [cli-duid]
| | +--rw cli-duid uint32
| | +--rw cli-domain-name string
| +--rw nisp-paras
| +--rw nisp-serv-addr inet:ipv6-address
| +--rw nisp-cli-info* [cli-duid]
| +--rw cli-duid uint32
| +--rw cli-domain-name string
+--rw relay-opaque-paras
| +--rw relays* [relay-name]
| +--rw relay-name string
| +--rw interface-info* [if-name]
| | +--rw if-name string
| | +--rw interface-id string
| +--rw subscribers* [subscriber]
| | +--rw subscriber uint8
| | +--rw subscriber-id string
| +--rw remote-host* [ent-num]
| +--rw ent-num uint8
| +--rw remote-id string
+--ro packet-stats
+--ro solicit-count uint32
+--ro request-count uint32
+--ro renew-count uint32
+--ro rebind-count uint32
+--ro decline-count uint32
+--ro release-count uint32
+--ro info-req-count uint32
+--ro advertise-count uint32
+--ro confirm-count uint32
+--ro reply-count uint32
+--ro reconfigure-count uint32
+--ro relay-forward-count uint32
+--ro relay-reply-count uint32
]]></artwork>
</figure>
<t>Introduction of important nodes:</t>
<t><list style="symbols">
<t>serv-attributes: This container contains basic attributes
of a DHCPv6 server such as DUID, server name and so on.
Some optional functions that can be provided by the server
is also included.</t>
<t>duid: Each server and client has only one DUID (DHCP
Unique Identifier). The DUID here identifies a unique
DHCPv6 server for clients.</t>
<t>pd-function: Whether the server can act as a delegating
router to perform prefix delegation (<xref target="RFC3633"/>).
</t>
<t>two-step-interaction : A boolean value specifies whether
the server support client-server exchanges involving two
messages defined in (<xref target="RFC3315"/>).</t>
<t>rapid-commit: Setting the value to '1' represents the
server support the Solicit-Reply message exchange. '0'
means the server will simply ignore the Rapid Commit
option in Solicit message.</t>
<t>address-pools: A container describes the DHCPv6 server's
address pools.</t>
<t>address-pool: A DHCPv6 server can be configured with
several address pools. This list defines such address pools
which are distinguish by the key called "pool-name".</t>
<t>binding-info: A list records a binding information for
each DHCPv6 client that has already been allocated IPv6
addresses.</t>
<t>prefix-pools: If a server supports prefix delegation
function, this container will be used to define the
delegating router's prefix pools.</t>
<t>prefix-pool: Similar to server's address pools, a
delegating router can also be configured with multiple
prefix pools specified by a list called "prefix-pool".</t>
<t>binding-info: A list records a binding information for
each DHCPv6 requesting router that has already been configured
IPv6 prefixes.</t>
<t>other-paras: This container defines extra configuration
parameters provided by the DHCPv6 server apart from the
address and prefix information. Such parameters may include
DNS servers, SIP servers, SNTP servers, etc.</t>
<t>relay-opaque-paras: This container contains some opaque values
in Relay Agent options that need to be configured on the server
side only for value match. Such Relay Agent options include
Interface-Id option, Remote-Id option and Subscriber-Id option.
</t>
<t>packet-stats: A container presents the packet statistics
related to the DHCPv6 server.</t>
</list></t>
</section>
<section anchor="dhcpv6-relay-tree" title="DHCPv6 Relay Tree Diagrams">
<figure>
<artwork><![CDATA[
+--rw dhcpv6
+-- ...
|
+--rw relay {dhcpv6-relay}?
+--rw relay-attributes
| +--rw name string
| +--rw enable boolean
| +--rw dest-addrs* inet:ipv6-address
| +--rw subscribers* [subscriber]
| | +--rw subscriber uint8
| | +--rw subscriber-id string
| +--rw remote-host* [entNum]
| | +--rw ent-num uint8
| | +--rw remote-id string
| +--ro vendor-info
| | +--ro ent-num uint8
| | +--ro data* string
| +--rw relay-interfaces
| +--rw relay-if* [if-name]
| +--rw if-name string
| +--rw enable boolean
| +--rw interface-id? string
| +--rw next-entity* [dest-addr]
| +--rw dest-addr inet:ipv6-address
| +--rw available boolean
| +--rw multicast boolean
| +--rw server boolean
| +--ro packet-stats
| +--ro cli-packet-rvd-count uint32
| +--ro solicit-rvd-count uint32
| +--ro request-rvd-count uint32
| +--ro renew-rvd-count uint32
| +--ro rebind-rvd-count uint32
| +--ro decline-rvd-count uint32
| +--ro release-rvd-count uint32
| +--ro info-req-rvd-count uint32
| +--ro relay-for-rvd-count uint32
| +--ro relay-rep-rvd-count uint32
| +--ro packet-to-cli-count uint32
| +--ro adver-sent-count uint32
| +--ro confirm-sent-count uint32
| +--ro reply-sent-count uint32
| +--ro reconfig-sent-count uint32
| +--ro relay-for-sent-count uint32
| +--ro relay-rep-sent-count uint32
+--ro relay-stats
+--ro cli-packet-rvd-count uint32
+--ro relay-for-rvd-count uint32
+--ro relay-rep-rvd-count uint32
+--ro packet-to-cli-count uint32
+--ro relay-for-sent-count uint32
+--ro relay-rep-sent-count uint32
+--ro discarded-packet-count uint32
]]></artwork>
</figure>
<t>Introduction of important nodes:</t>
<t><list style="symbols">
<t>relay-attributes: A container describes some basic
attributes of the relay agent including some relay agent
specific options data that need to be configured
previously. Such options include Remote-Id option and
Subscriber-Id option.</t>
<t>dest-addrs: Each DHCPv6 relay agent may be configured with
a list of destination addresses. This node defines such a list
of IPv6 addresses that may include unicast addresses, multicast
addresses or other addresses.</t>
<t>relay-interfaces: It is a sub-container of
"relayAttributes" that defines common configuration and
state parameters in the interfaces of a DHCPv6 relay
agent.</t>
<t>relay-if: A list describes a specific interface and its
corresponding parameters. Here we use a string called
"ifName" as the key of list.</t>
<t>next-entity: This node defines a list that is used to describe
the next hop entity of this relay agent. Different entities are
distinguished by their addresses.</t>
<t>packet-stats: A container shows packet state information
of a specific data communication.</t>
<t>relay-stats: The "relayStats" container records and presents
the overall packet statistics of the relay agent.</t>
</list></t>
</section>
<section anchor="dhcpv6-client-tree" title="DHCPv6 Client Tree Diagrams">
<figure>
<artwork><![CDATA[
+--rw dhcpv6
+-- ...
|
+--rw client {dhcpv6-client}?
+--rw client-interfaces
+--rw client-if* [if-name]
+--rw if-name string
+--ro duid uint32
+--rw enable boolean
+--rw cli-fqdn? string
+--rw pd-function boolean
+--rw rapid-commit boolean
+--rw dual-stack boolean
+--rw mo-tab
| +--rw m-tab boolean
| +--rw o-tab boolean
+--ro vendor-info
| +--ro ent-num uint8
| +--ro data* string
+--ro identity-associations
| +--ro identity-association* [iaid]
| +--ro iaid uint8
| +--ro ia-type string
| +--ro ipv6-addr* inet:ipv6-address
| +--ro ipv6-prefix* inet:ipv6-prefix
| +--ro prefix-length* uint8
| +--ro t1-time yang:date-and-time
| +--ro t2-time yang:date-and-time
| +--ro preferred-lifetime yang:timeticks
| +--ro valid-lifetime yang:timeticks
+--ro if-other-paras
| +--ro dns-serv-addr* inet:ipv6-address
| +--ro domain-search-list string
| +--ro sip-serv-addr* inet:ipv6-address
| +--ro sip-serv-domain-name-list string
| +--ro uni-dhcpv6-serv-addr inet:ipv6-address
| +--ro sntp-serv-addr* inet:ipv6-address
| +--ro ntp-serv-paras
| | +--ro ntp-serv-addr inet:ipv6-address
| | +--ro ntp-serv-mul-addr inet:ipv6-address
| | +--ro ntp-serv-fqdn string
| +--ro nis-paras
| | +--ro nis-serv-addr inet:ipv6-address
| | +--ro nis-cli-domain-name string
| +--ro nisp-paras
| +--ro nisp-serv-addr inet:ipv6-address
| +--ro nisp-cli-domain-name string
+--ro packet-stats
+--ro solicit-count uint32
+--ro request-count uint32
+--ro renew-count uint32
+--ro rebind-count uint32
+--ro decline-count uint32
+--ro release-count uint32
+--ro info-req-count uint32
+--ro advertise-count uint32
+--ro confirm-count uint32
+--ro reply-count uint32
+--ro reconfigure-count uint32
]]></artwork>
</figure>
<t>Introduction of important nodes:</t>
<t><list style="symbols">
<t>client-interfaces: A client may have several interfaces,
it is more reasonable to configure and manage parameters on
the interface-level. This container includes configuration
and state data of a DHCPv6 client in a per-interface manner.
</t>
<t>client-if: The list defines a specific client interface
and its data. Different interfaces are distinguished by the
"ifName" key which is a configurable string value.</t>
<t>duid: Each server and client has only one DUID (DHCP
Unique Identifier). The DUID here will be carried in the
Client ID option to identify a specific DHCPv6 client.</t>
<t>cli-fqdn: A DHCPv6 server needs to know the Fully Qualified
Domain Name (FQDN) of the client to achieve the DNS update.
</t>
<t>pd-function: Whether the client can act as a requesting
router to request prefixes using prefix delegation
(<xref target="RFC3633"/>).</t>
<t>rapid-commit: '1' indicates a client can initiate a
Solicit-Reply message exchange by adding a Rapid Commit
option in Solicit message. '0' means the client is not
allowed to add a Rapid Commit option to request addresses
in a two-message exchange pattern.</t>
<t>mo-tab: The management tab label indicates the operation
mode of the DHCPv6 client. 'm'=1 and 'o'=1 indicate the
client will use DHCPv6 to obtain all the configuration
data. 'm'=1 and 'o'=0 are a meaningless combination.
'm'=0 and 'o'=1 indicate the client will use stateless
DHCPv6 to obtain configuration data apart from
addresses/prefixes data. 'm'=0 and 'o'=0 represent the
client will not use DHCPv6 but use SLAAC to achieve
configuration.</t>
<t>identity-association: IA is a construct through which a
server and a client can identify, group, and manage a set of
related IPv6 addresses. The key of the "identity-association"
list is a 4-byte number IAID defined in <xref target="RFC3315"/>
.</t>
<t>if-other-paras: A client can obtain extra configuration
data other than address and prefix information through
DHCPv6. This container describes such data the client was
configured. The potential configuration data may include
DNS server addresses, SIP server domain names, etc.</t>
<t>packet-stats: A container records all the packet status
information of a specific interface.</t>
</list></t>
</section>
<section anchor="dhcpv6-notifications" title="Notifications Mechanism for DHCPv6">
<figure>
<artwork><![CDATA[
+--rw dhcpv6
+-- ...
|
+--n notifications
+--n dhcpv6-server-event {dhcpv6-server}?
| +--n addr-used-up
| | +--ro serv-duid uint32
| | +--ro serv-name? string
| | +--ro pool-name string
| +--n prefix-used-up
| | +--ro serv-duid uint32
| | +--ro serv-name? string
| | +--ro pool-name string
| +--n invalid-client-detected
| +--ro cli-duid uint32
| +--ro description? string
+--n dhcpv6-relay-event {dhcpv6-relay}?
| +--n topo-changed
| +--ro relay-if-name string
| +--ro first-hop boolean
| +--ro last-entity-addr inet:ipv6-address
+--n dhcpv6-client-event {dhcpv6-client}?
+--n invalid-ia-detected
| +--ro cli-duid uint32
| +--ro iaid uint8
| +--ro serv-duid? uint32
| +--ro description? string
+--n retransmission-failed
| +--ro cli-duid uint32
| +--ro description enumeration
+--n failed-status-turn-up
+--ro cli-duid uint32
+--ro status-code enumeration
]]></artwork>
</figure>
<t>Introduction of notifications:</t>
<t><list style="symbols">
<t>addr-used-up: raised when the address pool has run
out all its addresses.
</t>
<t>prefix-used-up: raised when the prefix pool has
run out all it prefixes.
</t>
<t>invalid-client-detected: raised when the server
has found a client which can be regarded as a potential
attacker. Some description could also be included.
</t>
<t>topo-changed: raised when the topology of the relay
agent is changed.
</t>
<t>invalid-ia-detected: raised when the identity
association of the client can be proved to be invalid.
Possible condition includes duplicated address, illegal
address, etc.
</t>
<t>retransmission-failed: raised when the retransmission
mechanism defined in <xref target="RFC3315"/> is failed.
</t>
<t>failed-status-turn-up: raised when the client receives
a message includes an unsuccessful Status Code option.
</t>
</list></t>
</section>
</section>
<section anchor="yang-model" title="DHCPv6 YANG Model">
<t>This module imports typedefs from <xref target="RFC6991"></xref>.</t>
<figure>
<artwork><![CDATA[
<CODE BEGINS> file "ietf-dhcpv6@2015-04-13.yang"
module ietf-dhcpv6 {
namespace "urn:ietf:params:xml:ns:yang:dhcpv6";
prefix "dhcpv6";
import ietf-inet-types { prefix inet; revision-date "2013-07-15"; }
import ietf-yang-types { prefix yang; revision-date "2013-07-15"; }
organization "dhc wg";
contact "yong@csnet1.cs.tsinghua.edu.cn
wangh13@mails.tsinghua.edu.cn
lh.sunlinh@gmail.com
Ted.Lemon@nominum.com
";
description "This model defines a YANG data model that can be used to configure
and manage DHCPv6 server, DHCPv6 relay and DHCPv6 client.";
revision 2015-04-13 {
description "Version02: Correct grammar errors.";
}
revision 2015-04-02 {
description "Version01: Correct grammar errors, Reuse groupings, Update
'dhcpv6-realy' feature, Add notifications.";
}
revision 2015-03-04 {
description "Version00: Initial revision.";
}
/*
* Features
*/
feature dhcpv6-server {
description
"Server in DHCPv6.";
reference
"RFC3315";
}
feature dhcpv6-relay {
description
"Relay agent in DHCPv6.";
reference
"RFC3315";
}
feature dhcpv6-client {
description
"Client in DHCPv6.";
reference
"RFC3315";
}
/*
* Grouping
*/
grouping vendor-info {
container vendor-info {
config "false";
leaf ent-num {
mandatory true;
type uint8;
}
leaf-list data {
type string;
}
}
}
/*
* Data Nodes
*/
container server {
if-feature dhcpv6-server;
container serv-attributes {
description "This container contains basic attributes of a DHCPv6 server
such as DUID, server name and so on. Some optional functions that
can be provided by the server is also included.";
leaf name {
mandatory true;
type string;
}
leaf duid {
config false;
description "Each server and client has only one DUID (DHCP Unique Identifier).
The DUID here identifies a unique DHCPv6 server for clients.";
mandatory true;
type uint32;
}
leaf enable {
mandatory true;
type boolean;
}
leaf description {
type string;
}
leaf pd-function {
description "Whether the server can act as a delegating router to perform
prefix delegation ([RFC3633]).";
mandatory true;
type boolean;
}
leaf stateless-service {
description "A boolean value specifies whether the server support client-server
exchanges involving two messages defined in ([RFC3315]).";
mandatory true;
type boolean;
}
leaf rapid-commit {
description "A boolean value specifies whether the server support client-server
exchanges involving two messages defined in ([RFC3315]).";
mandatory true;
type boolean;
}
uses vendor-info;
}
container address-pools {
description "A container describes the DHCPv6 server's address pools.";
list address-pool {
description "A DHCPv6 server can be configured with several address pools.
This list defines such address pools which are distinguish by
the key called 'pool-name'.";
key pool-id;
leaf pool-id {
mandatory true;
type uint8;
}
leaf pool-prefix {
mandatory true;
type inet:ipv6-prefix;
}
leaf start-address {
mandatory true;
type inet:ipv6-address-no-zone;
}
leaf end-address {
mandatory true;
type inet:ipv6-address-no-zone;
}
leaf preferred-lifetime {
mandatory true;
type yang:timeticks;
}
leaf valid-lifetime {
mandatory true;
type yang:timeticks;
}
leaf used-ipv6-count {
config "false";
mandatory true;
type uint32;
}
leaf idle-ipv6-count {
config "false";
mandatory true;
type uint32;
}
}
list binding-info {
config "false";
description "A list records a binding information for each DHCPv6 client that
has already been allocated IPv6 addresses.";
key cli-duid;
leaf cli-duid {
mandatory true;
type uint32;
}
list cli-ia {
key iaid;
leaf ia-type {
mandatory true;
type string;
}
leaf iaid {
mandatory true;
type uint8;
}
leaf-list cli-addr {
type inet:ipv6-address;
}
leaf pool-id {
type uint8;
}
}
}
}
container prefix-pools {
description "If a server supports prefix delegation function, this container
will be used to define the delegating router's refix pools.";
list prefix-pool {
description "Similar to server's address pools, a delegating router can also
be configured with multiple prefix pools specified by a list called
'prefix-pool'.";
key pool-id;
leaf pool-id {
mandatory true;
type uint8;
}
leaf prefix {
mandatory true;
type inet:ipv6-prefix;
}
leaf prefix-length {
mandatory true;
type uint8;
}
leaf preferred-lifetime {
mandatory true;
type yang:timeticks;
}
leaf valid-lifetime {
mandatory true;
type yang:timeticks;
}
}
list binding-info {
config "false";
description "A list records a binding information for each DHCPv6 client that
has already been allocated IPv6 addresses.";
key cli-duid;
leaf cli-duid {
mandatory true;
type uint32;
}
list cli-iapd {
key iaid;
leaf iaid {
mandatory true;
type uint8;
}
leaf-list cli-prefix {
type inet:ipv6-prefix;
}
leaf-list cli-prefix-len {
type uint8;
}
leaf pool-id {
type uint8;
}
}
}
}
container other-paras {
description "This container defines extra configuration parameters provided
by the DHCPv6 server apart from the address and prefix information.
Such parameters may include DNS servers, SIP servers, SNTP servers,
etc.";
list dns-server {
key dns-serv-id;
leaf dns-serv-id {
mandatory true;
type uint8;
}
leaf dns-serv-addr {
mandatory true;
type inet:ipv6-address;
}
}
leaf domain-search-list {
mandatory true;
type string;
}
list sip-server {
key sip-serv-id;
leaf sip-serv-id {
mandatory true;
type uint8;
}
leaf sip-serv-domain-name {
mandatory true;
type string;
}
leaf sip-serv-addr {
mandatory true;
type inet:ipv6-address;
}
}
list sntp-server {
key sntp-serv-id;
leaf sntp-serv-id {
mandatory true;
type uint8;
}
leaf sntp-serv-addr {
mandatory true;
type inet:ipv6-address;
}
}
list ntp-serv-paras {
key ntp-serv-id;
leaf ntp-serv-id {
mandatory true;
type uint8;
}
leaf ntp-serv-addr {
mandatory true;
type inet:ipv6-address;
}
leaf ntp-serv-mul-addr {
mandatory true;
type inet:ipv6-address;
}
leaf ntp-serv-fqdn {
mandatory true;
type string;
}
}
container nis-paras {
leaf nis-serv-addr {
mandatory true;
type inet:ipv6-address;
}
list nis-cli-info {
key cli-duid;
leaf cli-duid {
mandatory true;
type uint32;
}
leaf cli-domain-name {
mandatory true;
type string;
}
}
}
container nisp-paras {
leaf nisp-serv-addr {
mandatory true;
type inet:ipv6-address;
}
list nisp-cli-info {
key cli-duid;
leaf cli-duid {
mandatory true;
type uint32;
}
leaf cli-domain-name {
mandatory true;
type string;
}
}
}
}
container relay-opaque-paras {
description "This container contains some opaque values in Relay Agent options
that need to be configured on the server side only for value match.
Such Relay Agent options include Interface-Id option, Remote-Id
option and Subscriber-Id option.";
list relays {
key relay-name;
leaf relay-name {
mandatory true;
type string;
}
list interface-info {
key if-name;
leaf if-name {
mandatory true;
type string;
}
leaf interface-id {
mandatory true;
type string;
}
}
list subscribers {
key subscriber;
leaf subscriber {
mandatory true;
type string;
}
leaf subscriber-id {
mandatory true;
type string;
}
}
list remote-host {
key ent-num;
leaf ent-num {
mandatory true;
type uint8;
}
leaf remote-id {
mandatory true;
type string;
}
}
}
}
container packet-stats {
config "false";
description "A container presents the packet statistics related to the DHCPv6
server.";
leaf solicit-count {
mandatory true;
type uint32;
}
leaf request-count {
mandatory true;
type uint32;
}
leaf renew-count {
mandatory true;
type uint32;
}
leaf rebind-count {
mandatory true;
type uint32;
}
leaf decline-count {
mandatory true;
type uint32;
}
leaf release-count {
mandatory true;
type uint32;
}
leaf info-req-count {
mandatory true;
type uint32;
}
leaf advertise-count {
mandatory true;
type uint32;
}
leaf confirm-count {
mandatory true;
type uint32;
}
leaf reply-count {
mandatory true;
type uint32;
}
leaf reconfigure-count {
mandatory true;
type uint32;
}
leaf relay-forward-count {
mandatory true;
type uint32;
}
leaf relay-reply-count {
mandatory true;
type uint32;
}
}
}
container relay {
if-feature dhcpv6-relay;
container relay-attributes {
description "A container describes some basic attributes of the relay agent
including some relay agent specific options data that need to be configured
previously. Such options include Remote-Id option and Subscriber-Id option.";
leaf name {
mandatory true;
type string;
}
leaf enable {
mandatory true;
type boolean;
}
leaf-list dest-addrs {
description "Each DHCPv6 relay agent may be configured with a list of destination
addresses. This node defines such a list of IPv6 addresses that
may include unicast addresses, multicast addresses or other addresses.";
type inet:ipv6-address;
}
list subscribers {
key subscriber;
leaf subscriber {
mandatory true;
type string;
}
leaf subscriber-id {
mandatory true;
type string;
}
}
list remote-host {
key ent-num;
leaf ent-num {
mandatory true;
type uint8;
}
leaf remote-id {
mandatory true;
type string;
}
}
uses vendor-info;
container relay-interfaces {
description "It is a container that defines common configuration and state
parameters in the interfaces of a DHCPv6 relay agent. In this
YANG data model for DHCPv6 relay agent, the parameters are configured
in a per-interface manner.";
list relay-if {
description "A list describes a specific interface and its corresponding parameters.
Here we use a string called 'ifName' as the key of list.";
key if-name;
leaf if-name {
mandatory true;
type string;
}
leaf enable {
mandatory true;
type boolean;
}
leaf interface-id {
type string;
}
list next-entity {
description "This node defines a list that is used to describe the next hop
entity of this relay distinguished by their addresses.";
key dest-addr;
leaf dest-addr {
mandatory true;
type inet:ipv6-address;
}
leaf available {
mandatory true;
type boolean;
}
leaf multicast {
mandatory true;
type boolean;
}
leaf server {
mandatory true;
type boolean;
}
container packet-stats {
config "false";
description "A container shows packet state information of a specific interface.
It is a sub-container of the 'relayInterfaces' container.";
leaf cli-packet-rvd-count {
mandatory true;
type uint32;
}
leaf solicit-rvd-count {
mandatory true;
type uint32;
}
leaf request-rvd-count {
mandatory true;
type uint32;
}
leaf renew-rvd-count {
mandatory true;
type uint32;
}
leaf rebind-rvd-count {
mandatory true;
type uint32;
}
leaf decline-rvd-count {
mandatory true;
type uint32;
}
leaf release-rvd-count {
mandatory true;
type uint32;
}
leaf info-req-rvd-count {
mandatory true;
type uint32;
}
leaf relay-for-rvd-count {
mandatory true;
type uint32;
}
leaf relay-rep-rvd-count {
mandatory true;
type uint32;
}
leaf pac-to-cli-count {
mandatory true;
type uint32;
}
leaf adver-sent-count {
mandatory true;
type uint32;
}
leaf confirm-sent-count {
mandatory true;
type uint32;
}
leaf reply-sent-count {
mandatory true;
type uint32;
}
leaf reconfig-sent-count {
mandatory true;
type uint32;
}
leaf relay-for-sent-count {
mandatory true;
type uint32;
}
leaf relay-rep-sent-count {
mandatory true;
type uint32;
}
}
}
}
}
}
container relay-stats {
config "false";
description "The container records and presents the overall packet statistics
of the relay agent.";
leaf cli-packet-rvd-count {
mandatory true;
type uint32;
}
leaf relay-for-rvd-count {
mandatory true;
type uint32;
}
leaf relay-rep-rvd-count {
mandatory true;
type uint32;
}
leaf packet-to-cli-count {
mandatory true;
type uint32;
}
leaf relay-for-sent-count {
mandatory true;
type uint32;
}
leaf relay-rep-sent-count {
mandatory true;
type uint32;
}
leaf discarded-packet-count {
mandatory true;
type uint32;
}
}
}
container client {
if-feature dhcpv6-client;
container client-interfaces {
description "A client may have several interfaces, it is more reasonable to
configure and manage parameters on the interface-level. This container
includes configuration and state data of a DHCPv6 client in a
per-interface manner.";
list client-if {
description "The list defines a specific client interface and its data. Different
interfaces are distinguished by the key which is a configurable string
value.";
key if-name;
leaf if-name {
mandatory true;
type string;
}
leaf duid {
config "false";
description "Each server and client has only one DUID (DHCP Unique Identifier).
The DUID here will be carried in the Client ID option to identify
a specific DHCPv6 client.";
mandatory true;
type uint32;
}
leaf enable {
mandatory true;
type boolean;
}
leaf cli-fqdn {
description "A DHCPv6 server needs to know the Fully Qualified Domain Name
(FQDN) of the client to achieve the DNS update.";
type string;
}
leaf pd-function {
description "Whether the client can act as a requesting router to request
prefixes using prefix delegation ([RFC3633]).";
mandatory true;
type boolean;
}
leaf rapid-commit {
description "'1' indicates a client can initiate a Solicit-Reply message exchange
by adding a Rapid Commit option in Solicit message. '0' means
the client is not allowed to add a Rapid Commit option to request
addresses in a two-message exchange pattern.";
mandatory true;
type boolean;
}
leaf dual-stack {
mandatory true;
type boolean;
}
container mo-tab {
description "The management tab label indicates the operation mode of the
DHCPv6 client. 'm'=1 and 'o'=1 indicate the client will use DHCPv6
to obtain all the configuration data. 'm'=1 and 'o'=0 are a meaningless
combination. 'm'=0 and 'o'=1 indicate the client will use stateless
DHCPv6 to obtain configuration data apart from addresses/prefixes
data. 'm'=0 and 'o'=0 represent the client will not use DHCPv6
but use SLAAC to achieve configuration.";
leaf m-tab {
mandatory true;
type boolean;
}
leaf o-tab {
mandatory true;
type boolean;
}
}
uses vendor-info;
container identity-associations {
config "false";
description "IA is a construct through which a server and a client can identify,
group, and manage a set of related IPv6 addresses. The key of
the list is a 4-byte number IAID defined in [RFC3315] .";
list identity-association {
key iaid;
leaf iaid {
mandatory true;
type uint8;
}
leaf ia-type {
mandatory true;
type string;
}
leaf-list ipv6-addr {
type inet:ipv6-address;
}
leaf-list ipv6-prefix {
type inet:ipv6-prefix;
}
leaf-list prefix-length {
type uint8;
}
leaf t1-time {
mandatory true;
type yang:date-and-time;
}
leaf t2-time {
mandatory true;
type yang:date-and-time;
}
leaf preferred-lifetime {
mandatory true;
type yang:timeticks;
}
leaf valid-lifetime {
mandatory true;
type yang:timeticks;
}
}
}
container if-other-paras {
config "false";
description "A client can obtain extra configuration data other than address
and prefix information through DHCPv6. This container describes
such data the client was configured. The potential configuration
data may include DNS server addresses, SIP server domain names, etc.";
leaf-list dns-serv-addr {
type inet:ipv6-address;
}
leaf domain-search-list {
mandatory true;
type string;
}
leaf-list sip-serv-addr {
type inet:ipv6-address;
}
leaf sip-serv-domain-name-list {
mandatory true;
type string;
}
leaf uni-dhcpv6-serv-addr {
mandatory true;
type inet:ipv6-address;
}
leaf-list sntp-serv-addr {
type inet:ipv6-address;
}
container ntp-serv-paras {
leaf ntp-serv-addr {
mandatory true;
type inet:ipv6-address;
}
leaf ntp-serv-mul-addr {
mandatory true;
type inet:ipv6-address;
}
leaf ntp-serv-fqdn {
mandatory true;
type string;
}
}
container nis-paras {
leaf nis-serv-addr {
mandatory true;
type inet:ipv6-address;
}
leaf nis-cli-domain-name {
mandatory true;
type string;
}
}
container nisp-paras {
leaf nisp-serv-addr {
mandatory true;
type inet:ipv6-address;
}
leaf nisp-cli-domain-name {
mandatory true;
type string;
}
}
}
container packet-stats {
config "false";
description "A container records all the packet status information of a specific
interface.";
leaf solicit-count {
mandatory true;
type uint32;
}
leaf request-count {
mandatory true;
type uint32;
}
leaf renew-count {
mandatory true;
type uint32;
}
leaf rebind-count {
mandatory true;
type uint32;
}
leaf decline-count {
mandatory true;
type uint32;
}
leaf release-count {
mandatory true;
type uint32;
}
leaf info-req-count {
mandatory true;
type uint32;
}
leaf advertise-count {
mandatory true;
type uint32;
}
leaf confirm-count {
mandatory true;
type uint32;
}
leaf reply-count {
mandatory true;
type uint32;
}
leaf reconfigure-count {
mandatory true;
type uint32;
}
}
}
}
}
/*
* Notifications
*/
notification notifications {
container dhcpv6-server-event {
if-feature dhcpv6-server;
container addr-used-up {
leaf serv-duid {
mandatory true;
type uint32;
}
leaf serv-name {
type string;
}
leaf pool-name {
mandatory true;
type string;
}
}
container prefix-used-up {
leaf serv-duid {
mandatory true;
type uint32;
}
leaf serv-name {
type string;
}
leaf pool-name {
mandatory true;
type string;
}
}
container invalid-client-detected {
leaf cli-duid {
mandatory true;
type uint32;
}
leaf description {
type string;
}
}
}
container dhcpv6-relay-event {
if-feature dhcpv6-relay;
container topo-changed {
leaf relay-if-name {
mandatory true;
type string;
}
leaf first-hop {
mandatory true;
type boolean;
}
leaf last-entity-addr {
mandatory true;
type inet:ipv6-address;
}
}
}
container dhcpv6-client-event {
if-feature dhcpv6-client;
container invalid-ia-detected {
leaf cli-duid {
mandatory true;
type uint32;
}
leaf iaid {
mandatory true;
type uint8;
}
leaf serv-duid {
type uint32;
}
leaf description {
type string;
}
}
container retransmission-failed {
leaf cli-duid {
mandatory true;
type uint32;
}
leaf description {
mandatory true;
type enumeration {
enum "MRC failed";
enum "MRD failed";
}
}
}
container failed-status-turn-up {
leaf cli-duid {
mandatory true;
type uint32;
}
leaf status-code {
mandatory true;
type enumeration {
enum "1" {
description "UnspecFail";
}
enum "2" {
description "NoAddrAvail";
}
enum "3" {
description "NoBinding";
}
enum "4" {
description "NotOnLink";
}
enum "5" {
description "UseMulticast";
}
}
}
}
}
}
}
<CODE ENDS>
]]></artwork>
</figure>
</section>
<section anchor="security" title="Security Considerations (TBD)">
<t>TBD</t>
</section>
<section anchor="iana" title="IANA Considerations (TBD)">
<t>TBD</t>
</section>
<section anchor="acknowledgements" title="Acknowledgements (TBD)">
<t>TBD</t>
</section>
</middle>
<back>
<references title="Normative References">
<?rfc include='reference.RFC.2119'?>
<?rfc include='reference.RFC.3315'?>
<?rfc include='reference.RFC.3633'?>
<?rfc include='reference.RFC.6020'?>
<?rfc include='reference.RFC.6087'?>
<?rfc include='reference.RFC.6991'?>
</references>
</back>
</rfc>
| PAFTECH AB 2003-2026 | 2026-04-24 09:49:52 |