--- 1/draft-ietf-netmod-yang-types-01.txt 2009-03-09 19:12:16.000000000 +0100
+++ 2/draft-ietf-netmod-yang-types-02.txt 2009-03-09 19:12:16.000000000 +0100
@@ -1,131 +1,146 @@
Network Working Group J. Schoenwaelder, Ed.
Internet-Draft Jacobs University
-Intended status: Standards Track November 3, 2008
-Expires: May 7, 2009
+Intended status: Standards Track March 9, 2009
+Expires: September 10, 2009
Common YANG Data Types
- draft-ietf-netmod-yang-types-01
+ draft-ietf-netmod-yang-types-02
Status of this Memo
- By submitting this Internet-Draft, each author represents that any
- applicable patent or other IPR claims of which he or she is aware
- have been or will be disclosed, and any of which he or she becomes
- aware will be disclosed, in accordance with Section 6 of BCP 79.
+ This Internet-Draft is submitted to IETF in full conformance with the
+ provisions of BCP 78 and BCP 79. This document may contain material
+ from IETF Documents or IETF Contributions published or made publicly
+ available before November 10, 2008. The person(s) controlling the
+ copyright in some of this material may not have granted the IETF
+ Trust the right to allow modifications of such material outside the
+ IETF Standards Process. Without obtaining an adequate license from
+ the person(s) controlling the copyright in such materials, this
+ document may not be modified outside the IETF Standards Process, and
+ derivative works of it may not be created outside the IETF Standards
+ Process, except to format it for publication as an RFC or to
+ translate it into languages other than English.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
- This Internet-Draft will expire on May 7, 2009.
+ This Internet-Draft will expire on September 10, 2009.
Copyright Notice
- Copyright (C) The IETF Trust (2008).
+ Copyright (c) 2009 IETF Trust and the persons identified as the
+ document authors. All rights reserved.
+
+ This document is subject to BCP 78 and the IETF Trust's Legal
+ Provisions Relating to IETF Documents in effect on the date of
+ publication of this document (http://trustee.ietf.org/license-info).
+ Please review these documents carefully, as they describe your rights
+ and restrictions with respect to this document.
Abstract
This document introduces a collection of common data types to be used
with the YANG data modeling language.
Table of Contents
- 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
- 2. Core YANG Derived Types . . . . . . . . . . . . . . . . . . . 4
- 3. Internet Specific Derived Types . . . . . . . . . . . . . . . 12
- 4. IEEE Specific Derived Types . . . . . . . . . . . . . . . . . 21
- 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 24
- 6. Security Considerations . . . . . . . . . . . . . . . . . . . 25
- 7. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 26
- 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27
- 8.1. Normative References . . . . . . . . . . . . . . . . . . . 27
- 8.2. Informative References . . . . . . . . . . . . . . . . . . 27
- Appendix A. XSD Translations . . . . . . . . . . . . . . . . . . 30
- A.1. XSD of Core YANG Derived Types . . . . . . . . . . . . . . 30
- A.2. XSD of Internet Specific Derived Types . . . . . . . . . . 37
- A.3. XSD of IEEE Specific Derived Types . . . . . . . . . . . . 44
- Appendix B. RelaxNG Translations . . . . . . . . . . . . . . . . 47
- B.1. RelaxNG of Core YANG Derived Types . . . . . . . . . . . . 47
- B.2. RelaxNG of Internet Specific Derived Types . . . . . . . . 53
- B.3. RelaxNG of IEEE Specific Derived Types . . . . . . . . . . 58
- Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 61
- Intellectual Property and Copyright Statements . . . . . . . . . . 62
+ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
+ 2. Core YANG Derived Types . . . . . . . . . . . . . . . . . . . 5
+ 3. Internet Specific Derived Types . . . . . . . . . . . . . . . 13
+ 4. IEEE Specific Derived Types . . . . . . . . . . . . . . . . . 22
+ 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 25
+ 6. Security Considerations . . . . . . . . . . . . . . . . . . . 26
+ 7. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 27
+ 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 28
+ 8.1. Normative References . . . . . . . . . . . . . . . . . . . 28
+ 8.2. Informative References . . . . . . . . . . . . . . . . . . 28
+ Appendix A. XSD Translations . . . . . . . . . . . . . . . . . . 31
+ A.1. XSD of Core YANG Derived Types . . . . . . . . . . . . . . 31
+ A.2. XSD of Internet Specific Derived Types . . . . . . . . . . 38
+ A.3. XSD of IEEE Specific Derived Types . . . . . . . . . . . . 46
+ Appendix B. RelaxNG Translations . . . . . . . . . . . . . . . . 49
+ B.1. RelaxNG of Core YANG Derived Types . . . . . . . . . . . . 49
+ B.2. RelaxNG of Internet Specific Derived Types . . . . . . . . 55
+ B.3. RelaxNG of IEEE Specific Derived Types . . . . . . . . . . 61
+ Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 64
1. Introduction
YANG [YANG] is a data modeling language used to model configuration
and state data manipulated by the NETCONF [RFC4741] protocol. The
YANG language supports a small set of built-in data types and
provides mechanisms to derive other types from the built-in types.
This document introduces a collection of common data types derived
from the built-in YANG data types. The definitions are organized in
- several YANG modules. The "yang-types" module contains generally
- useful data types. The "inet-types" module contains definitions that
- are relevant for the Internet protocol suite while the "ieee-types"
- module contains definitions that are relevant for IEEE 802 protocols.
+ several YANG modules. The "ietf-yang-types" module contains
+ generally useful data types. The "ietf-inet-types" module contains
+ definitions that are relevant for the Internet protocol suite while
+ the "ietf-ieee-types" module contains definitions that are relevant
+ for IEEE 802 protocols.
Their derived types are generally designed to be applicable for
modeling all areas of management information.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14, [RFC2119].
2. Core YANG Derived Types
-module yang-types {
+ module ietf-yang-types {
namespace "urn:ietf:params:xml:ns:yang:yang-types";
prefix "yang";
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web:
WG List:
WG Chair: David Partain
- WG Chair: David Harrington
-
+ WG Chair: David Kessens
+
Editor: Juergen Schoenwaelder
";
description
"This module contains a collection of generally useful derived
YANG data types.
- Copyright (C) The IETF Trust (2008). This version of this
- YANG module is part of RFC XXXX; see the RFC itself for full
- legal notices.";
+ Copyright (C) 2009 The IETF Trust and the persons identified as
+ the document authors. This version of this YANG module is part
+ of RFC XXXX; see the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this note
- revision 2008-11-03 {
+ revision 2009-03-09 {
description
"Initial revision, published as RFC XXXX.";
}
// RFC Ed.: replace XXXX with actual RFC number and remove this note
/*** collection of counter and gauge types ***/
typedef counter32 {
type uint32;
description
@@ -309,28 +324,28 @@
since it is not restricted to 128 sub-identifiers.";
reference
"ISO/IEC 9834-1: Information technology -- Open Systems
Interconnection -- Procedures for the operation of OSI
Registration Authorities: General procedures and top
arcs of the ASN.1 Object Identifier tree";
}
typedef object-identifier-128 {
type object-identifier {
- pattern '\d*(.\d){1,127}';
+ pattern '\d*(.\d*){1,127}';
}
description
"This type represents object-identifiers restricted to 128
sub-identifiers.
- This type is in the value set and its semantics equivalent to
- the OBJECT IDENTIFIER type of the SMIv2.";
+ This type is in the value set and its semantics equivalent
+ to the OBJECT IDENTIFIER type of the SMIv2.";
reference
"RFC 2578: Structure of Management Information Version 2 (SMIv2)";
}
/*** collection of date and time related types ***/
typedef date-and-time {
type string {
pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?'
+ '(Z|(\+|-)\d{2}:\d{2})';
@@ -351,78 +366,83 @@
time-numoffset = ("+" / "-") time-hour ":" time-minute
time-offset = "Z" / time-numoffset
partial-time = time-hour ":" time-minute ":" time-second
[time-secfrac]
full-date = date-fullyear "-" date-month "-" date-mday
full-time = partial-time time-offset
date-time = full-date "T" full-time
- The date-and-time type is compatible with the dateTime XML
- schema type except that dateTime allows negative years
- which are not allowed by RFC 3339.
+ The date-and-time type is consistent with the semantics defined
+ in RFC 3339. The data-and-time type is compatible with the
+ dateTime XML schema type with the following two notable
+ exceptions:
+
+ (a) The data-and-time type does not allow negative years.
+
+ (b) The data-and-time time-offset -00:00 indicates an unknown
+ time zone (see RFC 3339) while -00:00 and +00:00 and Z all
+ represent the same time zone in dateTime.
This type is not equivalent to the DateAndTime textual
convention of the SMIv2 since RFC 3339 uses a different
separator between full-date and full-time and provides
- higher resolution of time-secfrac.';
-
- // [TODO] This type may require normalization rules since Z and
- // +00:00 mean the same - but note that -00:00 does not according
- // to RFC 3339 section 4.3 but it does according to XSD.
- // In addition, it is possible to write the same data and time
- // value using different time zones. XSD says the canonical format
- // is UTC using the Z format.
+ higher resolution of time-secfrac.
+ The canonical format for date-and-time values mandates the UTC
+ time format with the time-offset is indicated by the letter "Z".
+ This is consistent with the canonical format used by the
+ dateTime XML schema type.';
reference
"RFC 3339: Date and Time on the Internet: Timestamps
- RFC 2579: Textual Conventions for SMIv2";
+ RFC 2579: Textual Conventions for SMIv2
+ W3C REC-xmlschema-2-20041028: XML Schema Part 2: Datatypes
+ Second Edition";
}
typedef timeticks {
type uint32;
description
"The timeticks type represents a non-negative integer which
represents the time, modulo 2^32 (4294967296 decimal), in
hundredths of a second between two epochs. When objects
are defined which use this type, the description of the
object identifies both of the reference epochs.
- This type is in the value set and its semantics equivalent to
- the TimeStamp textual convention of the SMIv2.";
+ This type is in the value set and its semantics equivalent
+ to the TimeTicks type of the SMIv2.";
reference
- "RFC 2579: Textual Conventions for SMIv2";
+ "RFC 2578: Structure of Management Information Version 2 (SMIv2)";
}
typedef timestamp {
type yang:timeticks;
description
"The timestamp type represents the value of an associated
timeticks object at which a specific occurrence happened.
The specific occurrence must be defined in the description
of any object defined using this type. When the specific
occurrence occurred prior to the last time the associated
timeticks attribute was zero, then the timestamp value is
zero. Note that this requires all timestamp values to be
reset to zero when the value of the associated timeticks
attribute reaches 497+ days and wraps around to zero.
The associated timeticks object must be specified
in the description of any object using this type.
- This type is in the value set and its semantics equivalent to
- the TimeStamp textual convention of the SMIv2.";
+ This type is in the value set and its semantics equivalent
+ to the TimeStamp textual convention of the SMIv2.";
reference
"RFC 2579: Textual Conventions for SMIv2";
}
-
/*** collection of generic address types ***/
typedef phys-address {
type string {
pattern '([0-9a0-fA-F]{2}(:[0-9a0-fA-F]{2})*)?';
}
description
"Represents media- or physical-level addresses represented
as a sequence octets, each octet represented by two hexadecimal
numbers. Octets are separated by colons.
@@ -420,61 +440,73 @@
typedef phys-address {
type string {
pattern '([0-9a0-fA-F]{2}(:[0-9a0-fA-F]{2})*)?';
}
description
"Represents media- or physical-level addresses represented
as a sequence octets, each octet represented by two hexadecimal
numbers. Octets are separated by colons.
- This type is in the value set and its semantics equivalent to
- the PhysAddress textual convention of the SMIv2.";
+ This type is in the value set and its semantics equivalent
+ to the PhysAddress textual convention of the SMIv2.";
reference
"RFC 2579: Textual Conventions for SMIv2";
}
+ /*** collection of XML specific types ***/
+
+ typedef xpath { // [TODO] call this xpath1-0?
+ type string;
+ description
+ "This type represents an XPATH 1.0 expression.";
+ // [TODO] Normalization needed due to abbreviated syntax and the
+ // unabbreviated syntax? Whitespace stuff to take care of?
+ reference
+ "W3C REC-xpath-19991116: XML Path Language (XPath) Version 1.0";
+ }
+
}
3. Internet Specific Derived Types
- module inet-types {
+ module ietf-inet-types {
namespace "urn:ietf:params:xml:ns:yang:inet-types";
prefix "inet";
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web:
WG List:
WG Chair: David Partain
- WG Chair: David Harrington
-
+ WG Chair: David Kessens
+
Editor: Juergen Schoenwaelder
";
description
"This module contains a collection of generally useful derived
YANG data types for Internet addresses and related things.
- Copyright (C) The IETF Trust (2008). This version of this
- YANG module is part of RFC XXXX; see the RFC itself for full
- legal notices.";
+ Copyright (C) 2009 The IETF Trust and the persons identified as
+ the document authors. This version of this YANG module is part
+ of RFC XXXX; see the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this note
- revision 2008-11-03 {
+ revision 2009-03-09 {
description
"Initial revision, published as RFC XXXX.";
}
// RFC Ed.: replace XXXX with actual RFC number and remove this note
/*** collection of protocol field related types ***/
typedef ip-version {
type enumeration {
enum unknown {
@@ -560,46 +592,46 @@
reference
"RFC 768: User Datagram Protocol
RFC 793: Transmission Control Protocol
RFC 2960: Stream Control Transmission Protocol
RFC 4340: Datagram Congestion Control Protocol (DCCP)
RFC 4001: Textual Conventions for Internet Network Addresses";
}
/*** collection of autonomous system related types ***/
- typedef autonomous-system-number {
+ typedef as-number {
type uint32;
description
"The as-number type represents autonomous system numbers
which identify an Autonomous System (AS). An AS is a set
of routers under a single technical administration, using
an interior gateway protocol and common metrics to route
packets within the AS, and using an exterior gateway
protocol to route packets to other ASs'. IANA maintains
the AS number space and has delegated large parts to the
regional registries.
- Autonomous system numbers are currently limited to 16 bits
- (0..65535). There is however work in progress to enlarge
- the autonomous system number space to 32 bits. This
- textual convention therefore uses an uint32 base type
- without a range restriction in order to support a larger
- autonomous system number space.
+ Autonomous system numbers were originally limited to 16
+ bits. BGP extensions have enlarged the autonomous system
+ number space to 32 bits. This type therefore uses an uint32
+ base type without a range restriction in order to support
+ a larger autonomous system number space.
This type is in the value set and its semantics equivalent
to the InetAutonomousSystemNumber textual convention of
the SMIv2.";
reference
"RFC 1930: Guidelines for creation, selection, and registration
of an Autonomous System (AS)
RFC 4271: A Border Gateway Protocol 4 (BGP-4)
+ RFC 4893: BGP Support for Four-octet AS Number Space
RFC 4001: Textual Conventions for Internet Network Addresses";
}
/*** collection of IP address and hostname related types ***/
typedef ip-address {
type union {
type inet:ipv4-address;
type inet:ipv6-address;
}
@@ -625,24 +657,24 @@
}
description
"The ipv4-address type represents an IPv4 address in
dotted-quad notation. The IPv4 address may include a zone
index, separated by a % sign.
The zone index is used to disambiguate identical address
values. For link-local addresses, the zone index will
typically be the interface index number or the name of an
interface. If the zone index is not present, the default
- zone of the device will be used.";
+ zone of the device will be used.
- // [TODO] There is an normalization issue with regard to
- // systems that allow numeric and textual zone indexes.
+ The canonical format for the zone index is the numerical
+ format";
}
typedef ipv6-address {
type string {
pattern
/* full */
'((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+ '(%[\p{N}\p{L}]+)?)'
/* mixed */
+ '|((([0-9a-fA-F]{1,4}:){6})(([0-9]{1,3}\.'
@@ -660,28 +692,33 @@
}
description
"The ipv6-address type represents an IPv6 address in full,
mixed, shortened and shortened mixed notation. The IPv6
address may include a zone index, separated by a % sign.
The zone index is used to disambiguate identical address
values. For link-local addresses, the zone index will
typically be the interface index number or the name of an
interface. If the zone index is not present, the default
- zone of the device will be used.";
-
- // [TODO] Normalization needed due to the shortened and
- // mixed forms and the zone index?
+ zone of the device will be used.
+ The canonical format of IPv6 addresses must match the
+ pattern '((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+ with leading zeros suppressed as described in RFC 4291
+ section 2.2 item 1. The canonical format for the zone
+ index is the numerical format as described in RFC 4007
+ section 11.2.";
reference
- "RFC 4007: IPv6 Scoped Address Architecture";
+ "RFC 4291: IP Version 6 Addressing Architecture
+ RFC 4007: IPv6 Scoped Address Architecture";
}
+
// [TODO] The pattern needs to be checked; once YANG supports
// multiple pattern, we can perhaps be more precise.
typedef ip-prefix {
type union {
type inet:ipv4-prefix;
type inet:ipv6-prefix;
}
description
"The ip-prefix type represents an IP prefix and is IP
@@ -697,26 +734,23 @@
}
description
"The ipv4-prefix type represents an IPv4 address prefix.
The prefix length is given by the number following the
slash character and must be less than or equal to 32.
A prefix length value of n corresponds to an IP address
mask which has n contiguous 1-bits from the most
significant bit (MSB) and all other bits set to 0.
- The IPv4 address represented in dotted quad notation
- should have all bits that do not belong to the prefix
- set to zero.";
-
- // [TODO] Normalization needed since bits of the prefix
- // can be set arbitrarily.
+ The canonical format of an IPv4 prefix has all bits of
+ the IPv4 address set to zero that are not part of the
+ IPv4 prefix.";
}
typedef ipv6-prefix {
type string {
pattern
/* full */
'((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+ '/\d+)'
/* mixed */
+ '|((([0-9a-fA-F]{1,4}:){6})(([0-9]{1,3}\.'
@@ -735,63 +769,67 @@
description
"The ipv6-prefix type represents an IPv6 address prefix.
The prefix length is given by the number following the
slash character and must be less than or equal 128.
A prefix length value of n corresponds to an IP address
mask which has n contiguous 1-bits from the most
significant bit (MSB) and all other bits set to 0.
The IPv6 address should have all bits that do not belong
- to the prefix set to zero.";
+ to the prefix set to zero.
- // [TODO] Normalization needed due to the shortened and
- // mixed forms and since bits of the prefix can be set
- // arbitrarily.
+ The canonical format of an IPv6 prefix has all bits of
+ the IPv6 address set to zero that are not part of the
+ IPv6 prefix. Furthermore, the IPv6 address must match the
+ pattern '((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+ with leading zeros suppressed as described in RFC 4291
+ section 2.2 item 1.";
+ reference
+ "RFC 4291: IP Version 6 Addressing Architecture";
}
// [TODO] The pattern needs to be checked; once YANG supports
- // multiple pattern, we can perhaps be more precise.]
+ // multiple pattern, we can perhaps be more precise.
/*** collection of domain name and URI types ***/
typedef domain-name {
type string {
pattern '([a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.)*'
+ '[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]';
}
description
"The domain-name type represents a DNS domain name. The
name SHOULD be fully qualified whenever possible.
The description clause of objects using the domain-name
type MUST describe how (and when) these names are
resolved to IP addresses.
Note that the resolution of a domain-name value may
require to query multiple DNS records (e.g., A for IPv4
and AAAA for IPv6). The order of the resolution process
and which DNS record takes precedence depends on the
- configuration of the resolver.";
-
- // [TODO] Normalization needed since names are case
- // insensitive (normalize to lowercase characters).]
+ configuration of the resolver.
+ The canonical format for domain-name values uses the US-ASCII
+ encoding and case-insensitive characters are set to lowercase.";
reference
"RFC 1034: Domain Names - Concepts and Facilities
RFC 1123: Requirements for Internet Hosts -- Application
and Support";
}
// [TODO] RFC 2181 says there are no restrictions on DNS
- // labels. Need to check whether the pattern is too
- // restrictive.
+ // labels. Need to check whether the pattern above is too
+ // restrictive. We probably need advice from DNS experts.
typedef host {
type union {
type inet:ip-address;
type inet:domain-name;
}
description
"The host type represents either an IP address or a DNS
domain name.";
}
@@ -832,53 +870,51 @@
and Uniform Resource Names (URNs): Clarifications
and Recommendations
RFC 5017: MIB Textual Conventions for Uniform Resource
Identifiers (URIs)";
}
}
4. IEEE Specific Derived Types
- module ieee-types {
+ module ietf-ieee-types {
namespace "urn:ietf:params:xml:ns:yang:ieee-types";
prefix "ieee";
- import yang-types { prefix yang; }
-
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web:
WG List:
WG Chair: David Partain
- WG Chair: David Harrington
-
+ WG Chair: David Kessens
+
Editor: Juergen Schoenwaelder
";
description
"This module contains a collection of generally useful derived
YANG data types for IEEE 802 addresses and related things.
- Copyright (C) The IETF Trust (2008). This version of this
- YANG module is part of RFC XXXX; see the RFC itself for full
- legal notices.";
+ Copyright (C) 2009 The IETF Trust and the persons identified as
+ the document authors. This version of this YANG module is part
+ of RFC XXXX; see the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this note
- revision 2008-11-03 {
+ revision 2009-03-09 {
description
"Initial revision, published as RFC XXXX";
}
// RFC Ed.: replace XXXX with actual RFC number and remove this note
/*** collection of IEEE address type definitions ***/
typedef mac-address {
type string {
pattern '[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}';
@@ -940,31 +976,31 @@
}
5. IANA Considerations
A registry for standard YANG modules shall be set up. The name of
the registry is "IETF YANG Modules" and the registry shall record for
each entry the unique name of a YANG module, the assigned XML
namespace from the YANG URI Scheme, and a reference to the module's
documentation (typically and RFC). Allocations require IETF Review
- as defined in [RFC5226]. The initial assignements are:
+ as defined in [RFC5226]. The initial assignments are:
YANG Module XML namespace Reference
----------- -------------------------------------- ---------
yang-types urn:ietf:params:xml:ns:yang:yang-types RFC XXXX
inet-types urn:ietf:params:xml:ns:yang:inet-types RFC XXXX
ieee-types urn:ietf:params:xml:ns:yang:ieee-types RFC XXXX
RFC Ed.: replace XXXX with actual RFC number and remove this note
- This document registers three URIs1 in the IETF XML registry
+ This document registers three URIs in the IETF XML registry
[RFC3688]. Following the format in RFC 3688, the following
registration is requested.
URI: urn:ietf:params:xml:ns:yang:yang-types
URI: urn:ietf:params:xml:ns:yang:inet-types
URI: urn:ietf:params:xml:ns:yang:ieee-types
Registrant Contact: The NETMOD WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
@@ -991,26 +1027,22 @@
8. References
8.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004.
- [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
- IANA Considerations Section in RFCs", BCP 26, RFC 5226,
- May 2008.
-
[YANG] Bjorklund, M., Ed., "YANG - A data modeling language for
- NETCONF", draft-ietf-netmod-yang-01 (work in progress).
+ NETCONF", draft-ietf-netmod-yang-04 (work in progress).
8.2. Informative References
[802.1Q] ANSI/IEEE Standard 802.1Q, "IEEE Standards for Local and
Metropolitan Area Networks: Virtual Bridged Local Area
Networks", 2003.
[RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768,
August 1980.
@@ -1090,55 +1122,65 @@
[RFC4007] Deering, S., Haberman, B., Jinmei, T., Nordmark, E., and
B. Zill, "IPv6 Scoped Address Architecture", RFC 4007,
March 2005.
[RFC4188] Norseth, K. and E. Bell, "Definitions of Managed Objects
for Bridges", RFC 4188, September 2005.
[RFC4271] Rekhter, Y., Li, T., and S. Hares, "A Border Gateway
Protocol 4 (BGP-4)", RFC 4271, January 2006.
+ [RFC4291] Hinden, R. and S. Deering, "IP Version 6 Addressing
+ Architecture", RFC 4291, February 2006.
+
[RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram
Congestion Control Protocol (DCCP)", RFC 4340, March 2006.
[RFC4741] Enns, R., "NETCONF Configuration Protocol", RFC 4741,
December 2006.
+ [RFC4893] Vohra, Q. and E. Chen, "BGP Support for Four-octet AS
+ Number Space", RFC 4893, May 2007.
+
[RFC5017] McWalter, D., "MIB Textual Conventions for Uniform
Resource Identifiers (URIs)", RFC 5017, September 2007.
+ [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an
+ IANA Considerations Section in RFCs", BCP 26, RFC 5226,
+ May 2008.
+
Appendix A. XSD Translations
This appendix provides XML Schema (XSD) translations of the types
defined in this document. This appendix is informative and not
normative.
A.1. XSD of Core YANG Derived Types
+ version="2009-03-09"
+ xml:lang="en"
+ xmlns:yang="urn:ietf:params:xml:ns:yang:yang-types">
This module contains a collection of generally useful derived
YANG data types.
- Copyright (C) The IETF Trust (2008). This version of this
- YANG module is part of RFC XXXX; see the RFC itself for full
- legal notices.
+ Copyright (C) 2009 The IETF Trust and the persons identified as
+ the document authors. This version of this YANG module is part
+ of RFC XXXX; see the RFC itself for full legal notices.
The counter32 type represents a non-negative integer
which monotonically increases until it reaches a
@@ -1336,26 +1378,26 @@
)(\.(0|([1-9]\d*)))*"/>
This type represents object-identifiers restricted to 128
sub-identifiers.
- This type is in the value set and its semantics equivalent to
- the OBJECT IDENTIFIER type of the SMIv2.
+ This type is in the value set and its semantics equivalent
+ to the OBJECT IDENTIFIER type of the SMIv2.
-
+
The date-and-time type is a profile of the ISO 8601
standard for representation of dates and times using the
Gregorian calendar. The format is most easily described
using the following ABFN (see RFC 3339):
@@ -1370,48 +1412,61 @@
time-numoffset = ("+" / "-") time-hour ":" time-minute
time-offset = "Z" / time-numoffset
partial-time = time-hour ":" time-minute ":" time-second
[time-secfrac]
full-date = date-fullyear "-" date-month "-" date-mday
full-time = partial-time time-offset
date-time = full-date "T" full-time
- The date-and-time type is compatible with the dateTime XML
- schema type except that dateTime allows negative years
- which are not allowed by RFC 3339.
+ The date-and-time type is consistent with the semantics defined
+ in RFC 3339. The data-and-time type is compatible with the
+ dateTime XML schema type with the following two notable
+ exceptions:
+
+ (a) The data-and-time type does not allow negative years.
+
+ (b) The data-and-time time-offset -00:00 indicates an unknown
+ time zone (see RFC 3339) while -00:00 and +00:00 and Z all
+ represent the same time zone in dateTime.
This type is not equivalent to the DateAndTime textual
convention of the SMIv2 since RFC 3339 uses a different
separator between full-date and full-time and provides
higher resolution of time-secfrac.
+
+ The canonical format for date-and-time values mandates the UTC
+ time format with the time-offset is indicated by the letter "Z".
+
+ This is consistent with the canonical format used by the
+ dateTime XML schema type.
The timeticks type represents a non-negative integer which
represents the time, modulo 2^32 (4294967296 decimal), in
hundredths of a second between two epochs. When objects
are defined which use this type, the description of the
object identifies both of the reference epochs.
- This type is in the value set and its semantics equivalent to
- the TimeStamp textual convention of the SMIv2.
+ This type is in the value set and its semantics equivalent
+ to the TimeTicks type of the SMIv2.
@@ -1421,68 +1476,78 @@
of any object defined using this type. When the specific
occurrence occurred prior to the last time the associated
timeticks attribute was zero, then the timestamp value is
zero. Note that this requires all timestamp values to be
reset to zero when the value of the associated timeticks
attribute reaches 497+ days and wraps around to zero.
The associated timeticks object must be specified
in the description of any object using this type.
- This type is in the value set and its semantics equivalent to
- the TimeStamp textual convention of the SMIv2.
+ This type is in the value set and its semantics equivalent
+ to the TimeStamp textual convention of the SMIv2.
Represents media- or physical-level addresses represented
as a sequence octets, each octet represented by two hexadecimal
numbers. Octets are separated by colons.
- This type is in the value set and its semantics equivalent to
- the PhysAddress textual convention of the SMIv2.
+ This type is in the value set and its semantics equivalent
+ to the PhysAddress textual convention of the SMIv2.
+
+
+
+ This type represents an XPATH 1.0 expression.
+
+
+
+
+
+
+
A.2. XSD of Internet Specific Derived Types
-
+ version="2009-03-09"
+ xml:lang="en"
+ xmlns:inet="urn:ietf:params:xml:ns:yang:inet-types">
This module contains a collection of generally useful derived
YANG data types for Internet addresses and related things.
- Copyright (C) The IETF Trust (2008). This version of this
- YANG module is part of RFC XXXX; see the RFC itself for full
- legal notices.
+ Copyright (C) 2009 The IETF Trust and the persons identified as
+ the document authors. This version of this YANG module is part
+ of RFC XXXX; see the RFC itself for full legal notices.
This value represents the version of the IP protocol.
@@ -1551,38 +1615,37 @@
to the InetPortNumber textual convention of the SMIv2.
-
+
The as-number type represents autonomous system numbers
which identify an Autonomous System (AS). An AS is a set
of routers under a single technical administration, using
an interior gateway protocol and common metrics to route
packets within the AS, and using an exterior gateway
protocol to route packets to other ASs'. IANA maintains
the AS number space and has delegated large parts to the
regional registries.
- Autonomous system numbers are currently limited to 16 bits
- (0..65535). There is however work in progress to enlarge
- the autonomous system number space to 32 bits. This
- textual convention therefore uses an uint32 base type
- without a range restriction in order to support a larger
- autonomous system number space.
+ Autonomous system numbers were originally limited to 16
+ bits. BGP extensions have enlarged the autonomous system
+ number space to 32 bits. This type therefore uses an uint32
+ base type without a range restriction in order to support
+ a larger autonomous system number space.
This type is in the value set and its semantics equivalent
to the InetAutonomousSystemNumber textual convention of
the SMIv2.
@@ -1612,20 +1676,23 @@
The ipv4-address type represents an IPv4 address in
dotted-quad notation. The IPv4 address may include a zone
index, separated by a % sign.
The zone index is used to disambiguate identical address
values. For link-local addresses, the zone index will
typically be the interface index number or the name of an
interface. If the zone index is not present, the default
zone of the device will be used.
+
+ The canonical format for the zone index is the numerical
+ format
@@ -1635,20 +1702,27 @@
The ipv6-address type represents an IPv6 address in full,
mixed, shortened and shortened mixed notation. The IPv6
address may include a zone index, separated by a % sign.
The zone index is used to disambiguate identical address
values. For link-local addresses, the zone index will
typically be the interface index number or the name of an
interface. If the zone index is not present, the default
zone of the device will be used.
+
+ The canonical format of IPv6 addresses must match the
+ pattern '((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+ with leading zeros suppressed as described in RFC 4291
+ section 2.2 item 1. The canonical format for the zone
+ index is the numerical format as described in RFC 4007
+ section 11.2.
@@ -1710,20 +1784,27 @@
The ipv6-prefix type represents an IPv6 address prefix.
The prefix length is given by the number following the
slash character and must be less than or equal 128.
A prefix length value of n corresponds to an IP address
mask which has n contiguous 1-bits from the most
significant bit (MSB) and all other bits set to 0.
The IPv6 address should have all bits that do not belong
to the prefix set to zero.
+
+ The canonical format of an IPv6 prefix has all bits of
+ the IPv6 address set to zero that are not part of the
+ IPv6 prefix. Furthermore, the IPv6 address must match the
+ pattern '((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+ with leading zeros suppressed as described in RFC 4291
+ section 2.2 item 1.
@@ -1814,38 +1898,34 @@
A.3. XSD of IEEE Specific Derived Types
-
-
+ xmlns:ieee="urn:ietf:params:xml:ns:yang:ieee-types">
This module contains a collection of generally useful derived
YANG data types for IEEE 802 addresses and related things.
- Copyright (C) The IETF Trust (2008). This version of this
- YANG module is part of RFC XXXX; see the RFC itself for full
- legal notices.
+ Copyright (C) 2009 The IETF Trust and the persons identified as
+ the document authors. This version of this YANG module is part
+ of RFC XXXX; see the RFC itself for full legal notices.
The mac-address type represents an 802 MAC address represented
in the `canonical' order defined by IEEE 802.1a, i.e., as if it
@@ -1920,35 +1999,37 @@
namespace sch = "http://purl.oclc.org/dsdl/schematron"
namespace yang = "urn:ietf:params:xml:ns:yang:yang-types"
dc:creator [
"IETF NETMOD (NETCONF Data Modeling Language) Working Group"
]
dc:description [
"This module contains a collection of generally useful derived\x{a}" ~
"YANG data types.\x{a}" ~
"\x{a}" ~
- "Copyright (C) The IETF Trust (2008). This version of this\x{a}" ~
- "YANG module is part of RFC XXXX; see the RFC itself for full\x{a}" ~
- "legal notices."
+ "Copyright (C) 2009 The IETF Trust and the persons identif"
+ ~ "ied as\x{a}" ~
+ "the document authors. This version of this YANG module i"
+ ~ "s part\x{a}" ~
+ "of RFC XXXX; see the RFC itself for full legal notices."
]
-dc:issued [ "2008-11-03" ]
-dc:source [ "YANG module 'yang-types' (automatic translation)" ]
+dc:issued [ "2009-03-09" ]
+dc:source [ "YANG module 'ietf-yang-types' (automatic translation)" ]
dc:contributor [
"WG Web: \x{a}" ~
"WG List: \x{a}" ~
"\x{a}" ~
"WG Chair: David Partain\x{a}" ~
" \x{a}" ~
"\x{a}" ~
- "WG Chair: David Harrington\x{a}" ~
- " \x{a}" ~
+ "WG Chair: David Kessens\x{a}" ~
+ " \x{a}" ~
"\x{a}" ~
"Editor: Juergen Schoenwaelder\x{a}" ~
" "
]
## The counter32 type represents a non-negative integer
## which monotonically increases until it reaches a
## maximum value of 2^32-1 (4294967295 decimal), when it
## wraps around and starts increasing again from zero.
##
@@ -2112,22 +2193,22 @@
## arcs of the ASN.1 Object Identifier tree
object-identifier =
xsd:string {
pattern =
"(([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|([1-9]\d*)))*"
}
## This type represents object-identifiers restricted to 128
## sub-identifiers.
##
-## This type is in the value set and its semantics equivalent to
-## the OBJECT IDENTIFIER type of the SMIv2.
+## This type is in the value set and its semantics equivalent
+## to the OBJECT IDENTIFIER type of the SMIv2.
## See: RFC 2578: Structure of Management Information Version 2 (SMIv2)
object-identifier-128 = object-identifier
## The date-and-time type is a profile of the ISO 8601
## standard for representation of dates and times using the
## Gregorian calendar. The format is most easily described
## using the following ABFN (see RFC 3339):
##
## date-fullyear = 4DIGIT
@@ -2140,122 +2221,142 @@
## time-numoffset = ("+" / "-") time-hour ":" time-minute
## time-offset = "Z" / time-numoffset
##
## partial-time = time-hour ":" time-minute ":" time-second
## [time-secfrac]
## full-date = date-fullyear "-" date-month "-" date-mday
## full-time = partial-time time-offset
##
## date-time = full-date "T" full-time
##
-## The date-and-time type is compatible with the dateTime XML
-## schema type except that dateTime allows negative years
-## which are not allowed by RFC 3339.
+## The date-and-time type is consistent with the semantics defined
+## in RFC 3339. The data-and-time type is compatible with the
+## dateTime XML schema type with the following two notable
+## exceptions:
+##
+## (a) The data-and-time type does not allow negative years.
+##
+## (b) The data-and-time time-offset -00:00 indicates an unknown
+## time zone (see RFC 3339) while -00:00 and +00:00 and Z all
+## represent the same time zone in dateTime.
##
## This type is not equivalent to the DateAndTime textual
## convention of the SMIv2 since RFC 3339 uses a different
## separator between full-date and full-time and provides
## higher resolution of time-secfrac.
+##
+## The canonical format for date-and-time values mandates the UTC
+## time format with the time-offset is indicated by the letter "Z".
+## This is consistent with the canonical format used by the
+## dateTime XML schema type.
## See: RFC 3339: Date and Time on the Internet: Timestamps
## RFC 2579: Textual Conventions for SMIv2
+## W3C REC-xmlschema-2-20041028: XML Schema Part 2: Datatypes
+## Second Edition
date-and-time =
xsd:string {
pattern =
"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|(\+|-)\d{2}:\d{2})"
}
## The timeticks type represents a non-negative integer which
## represents the time, modulo 2^32 (4294967296 decimal), in
## hundredths of a second between two epochs. When objects
## are defined which use this type, the description of the
## object identifies both of the reference epochs.
##
-## This type is in the value set and its semantics equivalent to
-## the TimeStamp textual convention of the SMIv2.
+## This type is in the value set and its semantics equivalent
+## to the TimeTicks type of the SMIv2.
-## See: RFC 2579: Textual Conventions for SMIv2
+## See: RFC 2578: Structure of Management Information Version 2 (SMIv2)
timeticks = xsd:unsignedInt
## The timestamp type represents the value of an associated
## timeticks object at which a specific occurrence happened.
## The specific occurrence must be defined in the description
## of any object defined using this type. When the specific
## occurrence occurred prior to the last time the associated
## timeticks attribute was zero, then the timestamp value is
+
## zero. Note that this requires all timestamp values to be
## reset to zero when the value of the associated timeticks
## attribute reaches 497+ days and wraps around to zero.
##
## The associated timeticks object must be specified
## in the description of any object using this type.
##
-## This type is in the value set and its semantics equivalent to
-## the TimeStamp textual convention of the SMIv2.
+## This type is in the value set and its semantics equivalent
+## to the TimeStamp textual convention of the SMIv2.
## See: RFC 2579: Textual Conventions for SMIv2
timestamp = timeticks
## Represents media- or physical-level addresses represented
## as a sequence octets, each octet represented by two hexadecimal
## numbers. Octets are separated by colons.
-
##
-## This type is in the value set and its semantics equivalent to
-## the PhysAddress textual convention of the SMIv2.
+## This type is in the value set and its semantics equivalent
+## to the PhysAddress textual convention of the SMIv2.
## See: RFC 2579: Textual Conventions for SMIv2
phys-address =
xsd:string { pattern = "([0-9a0-fA-F]{2}(:[0-9a0-fA-F]{2})*)?" }
+## This type represents an XPATH 1.0 expression.
+
+## See: W3C REC-xpath-19991116: XML Path Language (XPath) Version 1.0
+xpath = xsd:string
+
B.2. RelaxNG of Internet Specific Derived Types
namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0"
namespace dc = "http://purl.org/dc/terms"
namespace dsrl = "http://purl.oclc.org/dsdl/dsrl"
namespace inet = "urn:ietf:params:xml:ns:yang:inet-types"
namespace nm = "urn:ietf:params:xml:ns:netmod:dsdl-attrib:1"
namespace sch = "http://purl.oclc.org/dsdl/schematron"
dc:creator [
"IETF NETMOD (NETCONF Data Modeling Language) Working Group"
]
dc:description [
"This module contains a collection of generally useful derived\x{a}" ~
"YANG data types for Internet addresses and related things.\x{a}" ~
"\x{a}" ~
- "Copyright (C) The IETF Trust (2008). This version of this\x{a}" ~
- "YANG module is part of RFC XXXX; see the RFC itself for full\x{a}" ~
- "legal notices."
+ "Copyright (C) 2009 The IETF Trust and the persons identif"
+ ~ "ied as\x{a}" ~
+ "the document authors. This version of this YANG module i"
+ ~ "s part\x{a}" ~
+ "of RFC XXXX; see the RFC itself for full legal notices."
]
-dc:issued [ "2008-11-03" ]
-dc:source [ "YANG module 'inet-types' (automatic translation)" ]
+dc:issued [ "2009-03-09" ]
+dc:source [ "YANG module 'ietf-inet-types' (automatic translation)" ]
dc:contributor [
"WG Web: \x{a}" ~
"WG List: \x{a}" ~
"\x{a}" ~
"WG Chair: David Partain\x{a}" ~
" \x{a}" ~
"\x{a}" ~
- "WG Chair: David Harrington\x{a}" ~
- " \x{a}" ~
+ "WG Chair: David Kessens\x{a}" ~
+ " \x{a}" ~
"\x{a}" ~
"Editor: Juergen Schoenwaelder\x{a}" ~
" "
]
## This value represents the version of the IP protocol.
##
## This type is in the value set and its semantics equivalent
## to the InetVersion textual convention of the SMIv2. However,
-
## the lexical appearance is different from the InetVersion
## textual convention.
## See: RFC 791: Internet Protocol
## RFC 2460: Internet Protocol, Version 6 (IPv6) Specification
## RFC 4001: Textual Conventions for Internet Network Addresses
ip-version = "unknown" | "ipv4" | "ipv6"
## The dscp type represents a Differentiated Services Code-Point
## that may be used for marking packets in a traffic stream.
@@ -2306,70 +2407,81 @@
## The as-number type represents autonomous system numbers
## which identify an Autonomous System (AS). An AS is a set
## of routers under a single technical administration, using
## an interior gateway protocol and common metrics to route
## packets within the AS, and using an exterior gateway
## protocol to route packets to other ASs'. IANA maintains
## the AS number space and has delegated large parts to the
## regional registries.
##
-## Autonomous system numbers are currently limited to 16 bits
-## (0..65535). There is however work in progress to enlarge
-## the autonomous system number space to 32 bits. This
-## textual convention therefore uses an uint32 base type
-## without a range restriction in order to support a larger
-## autonomous system number space.
+## Autonomous system numbers were originally limited to 16
+## bits. BGP extensions have enlarged the autonomous system
+## number space to 32 bits. This type therefore uses an uint32
+## base type without a range restriction in order to support
+## a larger autonomous system number space.
##
## This type is in the value set and its semantics equivalent
## to the InetAutonomousSystemNumber textual convention of
## the SMIv2.
## See: RFC 1930: Guidelines for creation, selection, and registration
## of an Autonomous System (AS)
## RFC 4271: A Border Gateway Protocol 4 (BGP-4)
+## RFC 4893: BGP Support for Four-octet AS Number Space
## RFC 4001: Textual Conventions for Internet Network Addresses
-autonomous-system-number = xsd:unsignedInt
+as-number = xsd:unsignedInt
## The ip-address type represents an IP address and is IP
## version neutral. The format of the textual representations
## implies the IP version.
ip-address = ipv4-address | ipv6-address
## The ipv4-address type represents an IPv4 address in
## dotted-quad notation. The IPv4 address may include a zone
## index, separated by a % sign.
##
## The zone index is used to disambiguate identical address
## values. For link-local addresses, the zone index will
## typically be the interface index number or the name of an
## interface. If the zone index is not present, the default
## zone of the device will be used.
+##
+## The canonical format for the zone index is the numerical
+## format
ipv4-address =
xsd:string {
pattern =
"((0|(1[0-9]{0,2})|(2(([0-4][0-9]?)|(5[0-5]?)|([6-9]?)"
~ "))|([3-9][0-9]?))\.){3}(0|(1[0-9]{0,2})|(2(([0-4][0-9]?)|(5["
~ "0-5]?)|([6-9]?)))|([3-9][0-9]?))(%[\p{N}\p{L}]+)?"
}
## The ipv6-address type represents an IPv6 address in full,
## mixed, shortened and shortened mixed notation. The IPv6
## address may include a zone index, separated by a % sign.
##
## The zone index is used to disambiguate identical address
## values. For link-local addresses, the zone index will
## typically be the interface index number or the name of an
## interface. If the zone index is not present, the default
## zone of the device will be used.
+##
+## The canonical format of IPv6 addresses must match the
+## pattern '((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+## with leading zeros suppressed as described in RFC 4291
+## section 2.2 item 1. The canonical format for the zone
+## index is the numerical format as described in RFC 4007
+## section 11.2.
-## See: RFC 4007: IPv6 Scoped Address Architecture
+## See: RFC 4291: IP Version 6 Addressing Architecture
+## RFC 4007: IPv6 Scoped Address Architecture
ipv6-address =
xsd:string {
pattern =
"((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})(%[\p{N}\p"
~ "{L}]+)?)|((([0-9a-fA-F]{1,4}:){6})(([0-9]{1,3}\.[0-9]{1,3}\."
~ "[0-9]{1,3}\.[0-9]{1,3}))(%[\p{N}\p{L}]+)?)|((([0-9a-fA-F]{1,"
~ "4}:)*([0-9a-fA-F]{1,4}))*(::)(([0-9a-fA-F]{1,4}:)*([0-9a-fA-"
~ "F]{1,4}))*(%[\p{N}\p{L}]+)?)|((([0-9a-fA-F]{1,4}:)*([0-9a-fA"
~ "-F]{1,4}))*(::)(([0-9a-fA-F]{1,4}:)*([0-9a-fA-F]{1,4}))*(([0"
~ "-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}))(%[\p{N}\p{L}]"
@@ -2382,40 +2494,50 @@
ip-prefix = ipv4-prefix | ipv6-prefix
## The ipv4-prefix type represents an IPv4 address prefix.
## The prefix length is given by the number following the
## slash character and must be less than or equal to 32.
##
## A prefix length value of n corresponds to an IP address
## mask which has n contiguous 1-bits from the most
## significant bit (MSB) and all other bits set to 0.
##
-## The IPv4 address represented in dotted quad notation
-## should have all bits that do not belong to the prefix
-## set to zero.
+## The canonical format of an IPv4 prefix has all bits of
+## the IPv4 address set to zero that are not part of the
+## IPv4 prefix.
ipv4-prefix =
xsd:string {
pattern =
"(([0-1]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-1]?"
~ "[0-9]?[0-9]|2[0-4][0-9]|25[0-5])/\d+"
}
## The ipv6-prefix type represents an IPv6 address prefix.
## The prefix length is given by the number following the
## slash character and must be less than or equal 128.
##
## A prefix length value of n corresponds to an IP address
## mask which has n contiguous 1-bits from the most
## significant bit (MSB) and all other bits set to 0.
##
## The IPv6 address should have all bits that do not belong
## to the prefix set to zero.
+
+##
+## The canonical format of an IPv6 prefix has all bits of
+## the IPv6 address set to zero that are not part of the
+## IPv6 prefix. Furthermore, the IPv6 address must match the
+## pattern '((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})'
+## with leading zeros suppressed as described in RFC 4291
+## section 2.2 item 1.
+
+## See: RFC 4291: IP Version 6 Addressing Architecture
ipv6-prefix =
xsd:string {
pattern =
"((([0-9a-fA-F]{1,4}:){7})([0-9a-fA-F]{1,4})/\d+)|(((["
~ "0-9a-fA-F]{1,4}:){6})(([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.["
~ "0-9]{1,3}))/\d+)|((([0-9a-fA-F]{1,4}:)*([0-9a-fA-F]{1,4}))*("
~ "::)(([0-9a-fA-F]{1,4}:)*([0-9a-fA-F]{1,4}))*/\d+)|((([0-9a-f"
~ "A-F]{1,4}:)*([0-9a-fA-F]{1,4}))*(::)(([0-9a-fA-F]{1,4}:)*([0"
~ "-9a-fA-F]{1,4}))*(([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]"
~ "{1,3}))/\d+)"
@@ -2426,20 +2548,23 @@
##
## The description clause of objects using the domain-name
## type MUST describe how (and when) these names are
## resolved to IP addresses.
##
## Note that the resolution of a domain-name value may
## require to query multiple DNS records (e.g., A for IPv4
## and AAAA for IPv6). The order of the resolution process
## and which DNS record takes precedence depends on the
## configuration of the resolver.
+##
+## The canonical format for domain-name values uses the US-ASCII
+## encoding and case-insensitive characters are set to lowercase.
## See: RFC 1034: Domain Names - Concepts and Facilities
## RFC 1123: Requirements for Internet Hosts -- Application
## and Support
domain-name =
xsd:string {
pattern =
"([a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.)*[a-zA-Z0-9]["
~ "a-zA-Z0-9\-]*[a-zA-Z0-9]"
}
@@ -2494,35 +2619,37 @@
namespace nm = "urn:ietf:params:xml:ns:netmod:dsdl-attrib:1"
namespace sch = "http://purl.oclc.org/dsdl/schematron"
dc:creator [
"IETF NETMOD (NETCONF Data Modeling Language) Working Group"
]
dc:description [
"This module contains a collection of generally useful derived\x{a}" ~
"YANG data types for IEEE 802 addresses and related things.\x{a}" ~
"\x{a}" ~
- "Copyright (C) The IETF Trust (2008). This version of this\x{a}" ~
- "YANG module is part of RFC XXXX; see the RFC itself for full\x{a}" ~
- "legal notices."
+ "Copyright (C) 2009 The IETF Trust and the persons identif"
+ ~ "ied as\x{a}" ~
+ "the document authors. This version of this YANG module i"
+ ~ "s part\x{a}" ~
+ "of RFC XXXX; see the RFC itself for full legal notices."
]
-dc:issued [ "2008-11-03" ]
-dc:source [ "YANG module 'ieee-types' (automatic translation)" ]
+dc:issued [ "2009-03-09" ]
+dc:source [ "YANG module 'ietf-ieee-types' (automatic translation)" ]
dc:contributor [
"WG Web: \x{a}" ~
"WG List: \x{a}" ~
"\x{a}" ~
"WG Chair: David Partain\x{a}" ~
" \x{a}" ~
"\x{a}" ~
- "WG Chair: David Harrington\x{a}" ~
- " \x{a}" ~
+ "WG Chair: David Kessens\x{a}" ~
+ " \x{a}" ~
"\x{a}" ~
"Editor: Juergen Schoenwaelder\x{a}" ~
" "
]
## The mac-address type represents an 802 MAC address represented
## in the `canonical' order defined by IEEE 802.1a, i.e., as if it
## were transmitted least significant bit first, even though 802.5
## (in contrast to other 802.x protocols) requires MAC addresses
## to be transmitted most significant bit first.
@@ -2564,55 +2691,10 @@
## Traffic Classes, Multicast Filtering, and Virtual
## LAN Extensions
vlanid = xsd:unsignedShort { minInclusive = "1" maxInclusive = "4094" }
Author's Address
Juergen Schoenwaelder (editor)
Jacobs University
Email: j.schoenwaelder@jacobs-university.de
-
-Full Copyright Statement
-
- Copyright (C) The IETF Trust (2008).
-
- This document is subject to the rights, licenses and restrictions
- contained in BCP 78, and except as set forth therein, the authors
- retain all their rights.
-
- This document and the information contained herein are provided on an
- "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
- OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
- THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
- OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
- THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
- WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
-
-Intellectual Property
-
- The IETF takes no position regarding the validity or scope of any
- Intellectual Property Rights or other rights that might be claimed to
- pertain to the implementation or use of the technology described in
- this document or the extent to which any license under such rights
- might or might not be available; nor does it represent that it has
- made any independent effort to identify any such rights. Information
- on the procedures with respect to rights in RFC documents can be
- found in BCP 78 and BCP 79.
-
- Copies of IPR disclosures made to the IETF Secretariat and any
- assurances of licenses to be made available, or the result of an
- attempt made to obtain a general license or permission for the use of
- such proprietary rights by implementers or users of this
- specification can be obtained from the IETF on-line IPR repository at
- http://www.ietf.org/ipr.
-
- The IETF invites any interested party to bring to its attention any
- copyrights, patents or patent applications, or other proprietary
- rights that may cover technology that may be required to implement
- this standard. Please address the information to the IETF at
- ietf-ipr@ietf.org.
-
-Acknowledgment
-
- Funding for the RFC Editor function is provided by the IETF
- Administrative Support Activity (IASA).