Representing Netconf Data Models using Document Schema Definition Languages (DSDL)
draft-ietf-netmod-dsdl-00

Document Type Active Internet-Draft (netmod WG)
Last updated 2020-03-19
Stream IETF
Intended RFC status (None)
Formats plain text pdf htmlized bibtex
Stream WG state Dead WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
NETCONF WG                                                       R. Mahy
Internet-Draft                                               Plantronics
Intended status: Informational                               S. Chisholm
Expires: January 8, 2009                                          Nortel
                                                               L. Lhotka
                                                                  CESNET
                                                            July 7, 2008

   Representing Netconf Data Models using Document Schema Definition
                            Languages (DSDL)
                     draft-ietf-netmod-dsdl-00.txt

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.

   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 January 8, 2009.

Copyright Notice

   Copyright (C) The IETF Trust (2008).

Abstract

   This document describes a concrete approach for representing Netconf
   and other IETF data models using the RelaxNG schema language and the
   Schematron validation language, which are both part of ISO's Document
   Schema Definition Languages (DSDL) standard.

Mahy, et al.             Expires January 8, 2009                [Page 1]
Internet-Draft              NETMOD using DSDL                  July 2008

Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  4
   2.  Overview . . . . . . . . . . . . . . . . . . . . . . . . . . .  5
   3.  RelaxNG  . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
   4.  Processing annotations for additional validation . . . . . . .  8
     4.1.  The 'unique' annotation  . . . . . . . . . . . . . . . . .  8
     4.2.  The 'key' annotation . . . . . . . . . . . . . . . . . . .  9
     4.3.  The 'keyref' annotation  . . . . . . . . . . . . . . . . . 11
     4.4.  The 'mustUse' annotation . . . . . . . . . . . . . . . . . 13
     4.5.  The 'infoType' annotation  . . . . . . . . . . . . . . . . 13
     4.6.  Additional validation rules  . . . . . . . . . . . . . . . 14
   5.  Validating instance data automatically with Schematron . . . . 15
     5.1.  Schematron patterns for data model validation  . . . . . . 16
     5.2.  Phases of validation . . . . . . . . . . . . . . . . . . . 18
   6.  Validating the data model itself . . . . . . . . . . . . . . . 19
   7.  Documentation annotations  . . . . . . . . . . . . . . . . . . 19
     7.1.  Creator information  . . . . . . . . . . . . . . . . . . . 19
     7.2.  Descriptions, defaults, and units  . . . . . . . . . . . . 20
     7.3.  Semantic Hints . . . . . . . . . . . . . . . . . . . . . . 21
   8.  Extensibility Model  . . . . . . . . . . . . . . . . . . . . . 22
     8.1.  Pattern scoping using modules  . . . . . . . . . . . . . . 22
     8.2.  Extending existing modules (forward compatibility) . . . . 23
     8.3.  Backwards Compatibility  . . . . . . . . . . . . . . . . . 24
     8.4.  Default Values . . . . . . . . . . . . . . . . . . . . . . 25
   9.  Netconf Specifics  . . . . . . . . . . . . . . . . . . . . . . 26
     9.1.  Get and Get-config operations  . . . . . . . . . . . . . . 26
     9.2.  Edit-config operations . . . . . . . . . . . . . . . . . . 26
     9.3.  Netconf notifications  . . . . . . . . . . . . . . . . . . 27
     9.4.  New netconf actions  . . . . . . . . . . . . . . . . . . . 29
     9.5.  Netconf specific error messages  . . . . . . . . . . . . . 29
     9.6.  Scope of an XML document . . . . . . . . . . . . . . . . . 31
   10. Conformance  . . . . . . . . . . . . . . . . . . . . . . . . . 32
     10.1. Cardinality  . . . . . . . . . . . . . . . . . . . . . . . 33
     10.2. Operations on managed objects  . . . . . . . . . . . . . . 33
     10.3. Element and Attribute Status . . . . . . . . . . . . . . . 34
     10.4. Additional Conformance Information . . . . . . . . . . . . 35
     10.5. Schema Level Conformance - Server-side . . . . . . . . . . 35
     10.6. Schema Level Conformance - Client-side . . . . . . . . . . 35
Show full document text