vnfs/TestVNF/netconftemplates/netconftemplates/ietf-yang-types@2013-07-15.yin

   1 <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="m-1">
   2   <data xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
   3 &lt;module name="ietf-yang-types"
   4         xmlns="urn:ietf:params:xml:ns:yang:yin:1"
   5         xmlns:yang="urn:ietf:params:xml:ns:yang:ietf-yang-types"&gt;
   6   &lt;namespace uri="urn:ietf:params:xml:ns:yang:ietf-yang-types"/&gt;
   7   &lt;prefix value="yang"/&gt;
   8   &lt;organization&gt;
   9     &lt;text&gt;IETF NETMOD (NETCONF Data Modeling Language) Working Group&lt;/text&gt;
  10   &lt;/organization&gt;
  11   &lt;contact&gt;
  12     &lt;text&gt;WG Web:   &amp;lt;http://tools.ietf.org/wg/netmod/&amp;gt;
  13 WG List:  &amp;lt;mailto:netmod@ietf.org&amp;gt;
  14
  15 WG Chair: David Kessens
  16           &amp;lt;mailto:david.kessens@nsn.com&amp;gt;
  17
  18 WG Chair: Juergen Schoenwaelder
  19           &amp;lt;mailto:j.schoenwaelder@jacobs-university.de&amp;gt;
  20
  21 Editor:   Juergen Schoenwaelder
  22           &amp;lt;mailto:j.schoenwaelder@jacobs-university.de&amp;gt;&lt;/text&gt;
  23   &lt;/contact&gt;
  24   &lt;description&gt;
  25     &lt;text&gt;This module contains a collection of generally useful derived
  26 YANG data types.
  27
  28 Copyright (c) 2013 IETF Trust and the persons identified as
  29 authors of the code.  All rights reserved.
  30
  31 Redistribution and use in source and binary forms, with or
  32 without modification, is permitted pursuant to, and subject
  33 to the license terms contained in, the Simplified BSD License
  34 set forth in Section 4.c of the IETF Trust's Legal Provisions
  35 Relating to IETF Documents
  36 (http://trustee.ietf.org/license-info).
  37
  38 This version of this YANG module is part of RFC 6991; see
  39 the RFC itself for full legal notices.&lt;/text&gt;
  40   &lt;/description&gt;
  41   &lt;revision date="2013-07-15"&gt;
  42     &lt;description&gt;
  43       &lt;text&gt;This revision adds the following new data types:
  44 - yang-identifier
  45 - hex-string
  46 - uuid
  47 - dotted-quad&lt;/text&gt;
  48     &lt;/description&gt;
  49     &lt;reference&gt;
  50       &lt;text&gt;RFC 6991: Common YANG Data Types&lt;/text&gt;
  51     &lt;/reference&gt;
  52   &lt;/revision&gt;
  53   &lt;revision date="2010-09-24"&gt;
  54     &lt;description&gt;
  55       &lt;text&gt;Initial revision.&lt;/text&gt;
  56     &lt;/description&gt;
  57     &lt;reference&gt;
  58       &lt;text&gt;RFC 6021: Common YANG Data Types&lt;/text&gt;
  59     &lt;/reference&gt;
  60   &lt;/revision&gt;
  61   &lt;typedef name="counter32"&gt;
  62     &lt;type name="uint32"/&gt;
  63     &lt;description&gt;
  64       &lt;text&gt;The counter32 type represents a non-negative integer
  65 that monotonically increases until it reaches a
  66 maximum value of 2^32-1 (4294967295 decimal), when it
  67 wraps around and starts increasing again from zero.
  68
  69 Counters have no defined 'initial' value, and thus, a
  70 single value of a counter has (in general) no information
  71 content.  Discontinuities in the monotonically increasing
  72 value normally occur at re-initialization of the
  73 management system, and at other times as specified in the
  74 description of a schema node using this type.  If such
  75 other times can occur, for example, the creation of
  76 a schema node of type counter32 at times other than
  77 re-initialization, then a corresponding schema node
  78 should be defined, with an appropriate type, to indicate
  79 the last discontinuity.
  80
  81 The counter32 type should not be used for configuration
  82 schema nodes.  A default statement SHOULD NOT be used in
  83 combination with the type counter32.
  84
  85 In the value set and its semantics, this type is equivalent
  86 to the Counter32 type of the SMIv2.&lt;/text&gt;
  87     &lt;/description&gt;
  88     &lt;reference&gt;
  89       &lt;text&gt;RFC 2578: Structure of Management Information Version 2
  90           (SMIv2)&lt;/text&gt;
  91     &lt;/reference&gt;
  92   &lt;/typedef&gt;
  93   &lt;typedef name="zero-based-counter32"&gt;
  94     &lt;type name="yang:counter32"/&gt;
  95     &lt;default value="0"/&gt;
  96     &lt;description&gt;
  97       &lt;text&gt;The zero-based-counter32 type represents a counter32
  98 that has the defined 'initial' value zero.
  99
 100 A schema node of this type will be set to zero (0) on creation
 101 and will thereafter increase monotonically until it reaches
 102 a maximum value of 2^32-1 (4294967295 decimal), when it
 103 wraps around and starts increasing again from zero.
 104
 105 Provided that an application discovers a new schema node
 106 of this type within the minimum time to wrap, it can use the
 107 'initial' value as a delta.  It is important for a management
 108 station to be aware of this minimum time and the actual time
 109 between polls, and to discard data if the actual time is too
 110 long or there is no defined minimum time.
 111
 112 In the value set and its semantics, this type is equivalent
 113 to the ZeroBasedCounter32 textual convention of the SMIv2.&lt;/text&gt;
 114     &lt;/description&gt;
 115     &lt;reference&gt;
 116       &lt;text&gt;RFC 4502: Remote Network Monitoring Management Information
 117           Base Version 2&lt;/text&gt;
 118     &lt;/reference&gt;
 119   &lt;/typedef&gt;
 120   &lt;typedef name="counter64"&gt;
 121     &lt;type name="uint64"/&gt;
 122     &lt;description&gt;
 123       &lt;text&gt;The counter64 type represents a non-negative integer
 124 that monotonically increases until it reaches a
 125 maximum value of 2^64-1 (18446744073709551615 decimal),
 126 when it wraps around and starts increasing again from zero.
 127
 128 Counters have no defined 'initial' value, and thus, a
 129 single value of a counter has (in general) no information
 130 content.  Discontinuities in the monotonically increasing
 131 value normally occur at re-initialization of the
 132 management system, and at other times as specified in the
 133 description of a schema node using this type.  If such
 134 other times can occur, for example, the creation of
 135 a schema node of type counter64 at times other than
 136 re-initialization, then a corresponding schema node
 137 should be defined, with an appropriate type, to indicate
 138 the last discontinuity.
 139
 140 The counter64 type should not be used for configuration
 141 schema nodes.  A default statement SHOULD NOT be used in
 142 combination with the type counter64.
 143
 144 In the value set and its semantics, this type is equivalent
 145 to the Counter64 type of the SMIv2.&lt;/text&gt;
 146     &lt;/description&gt;
 147     &lt;reference&gt;
 148       &lt;text&gt;RFC 2578: Structure of Management Information Version 2
 149           (SMIv2)&lt;/text&gt;
 150     &lt;/reference&gt;
 151   &lt;/typedef&gt;
 152   &lt;typedef name="zero-based-counter64"&gt;
 153     &lt;type name="yang:counter64"/&gt;
 154     &lt;default value="0"/&gt;
 155     &lt;description&gt;
 156       &lt;text&gt;The zero-based-counter64 type represents a counter64 that
 157 has the defined 'initial' value zero.
 158
 159 A schema node of this type will be set to zero (0) on creation
 160 and will thereafter increase monotonically until it reaches
 161 a maximum value of 2^64-1 (18446744073709551615 decimal),
 162 when it wraps around and starts increasing again from zero.
 163
 164 Provided that an application discovers a new schema node
 165 of this type within the minimum time to wrap, it can use the
 166 'initial' value as a delta.  It is important for a management
 167 station to be aware of this minimum time and the actual time
 168 between polls, and to discard data if the actual time is too
 169 long or there is no defined minimum time.
 170
 171 In the value set and its semantics, this type is equivalent
 172 to the ZeroBasedCounter64 textual convention of the SMIv2.&lt;/text&gt;
 173     &lt;/description&gt;
 174     &lt;reference&gt;
 175       &lt;text&gt;RFC 2856: Textual Conventions for Additional High Capacity
 176           Data Types&lt;/text&gt;
 177     &lt;/reference&gt;
 178   &lt;/typedef&gt;
 179   &lt;typedef name="gauge32"&gt;
 180     &lt;type name="uint32"/&gt;
 181     &lt;description&gt;
 182       &lt;text&gt;The gauge32 type represents a non-negative integer, which
 183 may increase or decrease, but shall never exceed a maximum
 184 value, nor fall below a minimum value.  The maximum value
 185 cannot be greater than 2^32-1 (4294967295 decimal), and
 186 the minimum value cannot be smaller than 0.  The value of
 187 a gauge32 has its maximum value whenever the information
 188 being modeled is greater than or equal to its maximum
 189 value, and has its minimum value whenever the information
 190 being modeled is smaller than or equal to its minimum value.
 191 If the information being modeled subsequently decreases
 192 below (increases above) the maximum (minimum) value, the
 193 gauge32 also decreases (increases).
 194
 195 In the value set and its semantics, this type is equivalent
 196 to the Gauge32 type of the SMIv2.&lt;/text&gt;
 197     &lt;/description&gt;
 198     &lt;reference&gt;
 199       &lt;text&gt;RFC 2578: Structure of Management Information Version 2
 200           (SMIv2)&lt;/text&gt;
 201     &lt;/reference&gt;
 202   &lt;/typedef&gt;
 203   &lt;typedef name="gauge64"&gt;
 204     &lt;type name="uint64"/&gt;
 205     &lt;description&gt;
 206       &lt;text&gt;The gauge64 type represents a non-negative integer, which
 207 may increase or decrease, but shall never exceed a maximum
 208 value, nor fall below a minimum value.  The maximum value
 209 cannot be greater than 2^64-1 (18446744073709551615), and
 210 the minimum value cannot be smaller than 0.  The value of
 211 a gauge64 has its maximum value whenever the information
 212 being modeled is greater than or equal to its maximum
 213 value, and has its minimum value whenever the information
 214 being modeled is smaller than or equal to its minimum value.
 215 If the information being modeled subsequently decreases
 216 below (increases above) the maximum (minimum) value, the
 217 gauge64 also decreases (increases).
 218
 219 In the value set and its semantics, this type is equivalent
 220 to the CounterBasedGauge64 SMIv2 textual convention defined
 221 in RFC 2856&lt;/text&gt;
 222     &lt;/description&gt;
 223     &lt;reference&gt;
 224       &lt;text&gt;RFC 2856: Textual Conventions for Additional High Capacity
 225           Data Types&lt;/text&gt;
 226     &lt;/reference&gt;
 227   &lt;/typedef&gt;
 228   &lt;typedef name="object-identifier"&gt;
 229     &lt;type name="string"&gt;
 230       &lt;pattern value="(([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|([1-9]\d*)))*"/&gt;
 231     &lt;/type&gt;
 232     &lt;description&gt;
 233       &lt;text&gt;The object-identifier type represents administratively
 234 assigned names in a registration-hierarchical-name tree.
 235
 236 Values of this type are denoted as a sequence of numerical
 237 non-negative sub-identifier values.  Each sub-identifier
 238 value MUST NOT exceed 2^32-1 (4294967295).  Sub-identifiers
 239 are separated by single dots and without any intermediate
 240 whitespace.
 241
 242 The ASN.1 standard restricts the value space of the first
 243 sub-identifier to 0, 1, or 2.  Furthermore, the value space
 244 of the second sub-identifier is restricted to the range
 245 0 to 39 if the first sub-identifier is 0 or 1.  Finally,
 246 the ASN.1 standard requires that an object identifier
 247 has always at least two sub-identifiers.  The pattern
 248 captures these restrictions.
 249
 250 Although the number of sub-identifiers is not limited,
 251 module designers should realize that there may be
 252 implementations that stick with the SMIv2 limit of 128
 253 sub-identifiers.
 254
 255 This type is a superset of the SMIv2 OBJECT IDENTIFIER type
 256 since it is not restricted to 128 sub-identifiers.  Hence,
 257 this type SHOULD NOT be used to represent the SMIv2 OBJECT
 258 IDENTIFIER type; the object-identifier-128 type SHOULD be
 259 used instead.&lt;/text&gt;
 260     &lt;/description&gt;
 261     &lt;reference&gt;
 262       &lt;text&gt;ISO9834-1: Information technology -- Open Systems
 263 Interconnection -- Procedures for the operation of OSI
 264 Registration Authorities: General procedures and top
 265 arcs of the ASN.1 Object Identifier tree&lt;/text&gt;
 266     &lt;/reference&gt;
 267   &lt;/typedef&gt;
 268   &lt;typedef name="object-identifier-128"&gt;
 269     &lt;type name="object-identifier"&gt;
 270       &lt;pattern value="\d*(\.\d*){1,127}"/&gt;
 271     &lt;/type&gt;
 272     &lt;description&gt;
 273       &lt;text&gt;This type represents object-identifiers restricted to 128
 274 sub-identifiers.
 275
 276 In the value set and its semantics, this type is equivalent
 277 to the OBJECT IDENTIFIER type of the SMIv2.&lt;/text&gt;
 278     &lt;/description&gt;
 279     &lt;reference&gt;
 280       &lt;text&gt;RFC 2578: Structure of Management Information Version 2
 281           (SMIv2)&lt;/text&gt;
 282     &lt;/reference&gt;
 283   &lt;/typedef&gt;
 284   &lt;typedef name="yang-identifier"&gt;
 285     &lt;type name="string"&gt;
 286       &lt;length value="1..max"/&gt;
 287       &lt;pattern value="[a-zA-Z_][a-zA-Z0-9\-_.]*"/&gt;
 288       &lt;pattern value=".|..|[^xX].*|.[^mM].*|..[^lL].*"/&gt;
 289     &lt;/type&gt;
 290     &lt;description&gt;
 291       &lt;text&gt;A YANG identifier string as defined by the 'identifier'
 292 rule in Section 12 of RFC 6020.  An identifier must
 293 start with an alphabetic character or an underscore
 294 followed by an arbitrary sequence of alphabetic or
 295 numeric characters, underscores, hyphens, or dots.
 296
 297 A YANG identifier MUST NOT start with any possible
 298 combination of the lowercase or uppercase character
 299 sequence 'xml'.&lt;/text&gt;
 300     &lt;/description&gt;
 301     &lt;reference&gt;
 302       &lt;text&gt;RFC 6020: YANG - A Data Modeling Language for the Network
 303           Configuration Protocol (NETCONF)&lt;/text&gt;
 304     &lt;/reference&gt;
 305   &lt;/typedef&gt;
 306   &lt;typedef name="date-and-time"&gt;
 307     &lt;type name="string"&gt;
 308       &lt;pattern value="\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2})"/&gt;
 309     &lt;/type&gt;
 310     &lt;description&gt;
 311       &lt;text&gt;The date-and-time type is a profile of the ISO 8601
 312 standard for representation of dates and times using the
 313 Gregorian calendar.  The profile is defined by the
 314 date-time production in Section 5.6 of RFC 3339.
 315
 316 The date-and-time type is compatible with the dateTime XML
 317 schema type with the following notable exceptions:
 318
 319 (a) The date-and-time type does not allow negative years.
 320
 321 (b) The date-and-time time-offset -00:00 indicates an unknown
 322     time zone (see RFC 3339) while -00:00 and +00:00 and Z
 323     all represent the same time zone in dateTime.
 324
 325 (c) The canonical format (see below) of data-and-time values
 326     differs from the canonical format used by the dateTime XML
 327     schema type, which requires all times to be in UTC using
 328     the time-offset 'Z'.
 329
 330 This type is not equivalent to the DateAndTime textual
 331 convention of the SMIv2 since RFC 3339 uses a different
 332 separator between full-date and full-time and provides
 333 higher resolution of time-secfrac.
 334
 335 The canonical format for date-and-time values with a known time
 336 zone uses a numeric time zone offset that is calculated using
 337 the device's configured known offset to UTC time.  A change of
 338 the device's offset to UTC time will cause date-and-time values
 339 to change accordingly.  Such changes might happen periodically
 340 in case a server follows automatically daylight saving time
 341 (DST) time zone offset changes.  The canonical format for
 342 date-and-time values with an unknown time zone (usually
 343 referring to the notion of local time) uses the time-offset
 344 -00:00.&lt;/text&gt;
 345     &lt;/description&gt;
 346     &lt;reference&gt;
 347       &lt;text&gt;RFC 3339: Date and Time on the Internet: Timestamps
 348 RFC 2579: Textual Conventions for SMIv2
 349 XSD-TYPES: XML Schema Part 2: Datatypes Second Edition&lt;/text&gt;
 350     &lt;/reference&gt;
 351   &lt;/typedef&gt;
 352   &lt;typedef name="timeticks"&gt;
 353     &lt;type name="uint32"/&gt;
 354     &lt;description&gt;
 355       &lt;text&gt;The timeticks type represents a non-negative integer that
 356 represents the time, modulo 2^32 (4294967296 decimal), in
 357 hundredths of a second between two epochs.  When a schema
 358 node is defined that uses this type, the description of
 359 the schema node identifies both of the reference epochs.
 360
 361 In the value set and its semantics, this type is equivalent
 362 to the TimeTicks type of the SMIv2.&lt;/text&gt;
 363     &lt;/description&gt;
 364     &lt;reference&gt;
 365       &lt;text&gt;RFC 2578: Structure of Management Information Version 2
 366           (SMIv2)&lt;/text&gt;
 367     &lt;/reference&gt;
 368   &lt;/typedef&gt;
 369   &lt;typedef name="timestamp"&gt;
 370     &lt;type name="yang:timeticks"/&gt;
 371     &lt;description&gt;
 372       &lt;text&gt;The timestamp type represents the value of an associated
 373 timeticks schema node at which a specific occurrence
 374 happened.  The specific occurrence must be defined in the
 375 description of any schema node defined using this type.  When
 376 the specific occurrence occurred prior to the last time the
 377 associated timeticks attribute was zero, then the timestamp
 378 value is zero.  Note that this requires all timestamp values
 379 to be reset to zero when the value of the associated timeticks
 380 attribute reaches 497+ days and wraps around to zero.
 381
 382 The associated timeticks schema node must be specified
 383 in the description of any schema node using this type.
 384
 385 In the value set and its semantics, this type is equivalent
 386 to the TimeStamp textual convention of the SMIv2.&lt;/text&gt;
 387     &lt;/description&gt;
 388     &lt;reference&gt;
 389       &lt;text&gt;RFC 2579: Textual Conventions for SMIv2&lt;/text&gt;
 390     &lt;/reference&gt;
 391   &lt;/typedef&gt;
 392   &lt;typedef name="phys-address"&gt;
 393     &lt;type name="string"&gt;
 394       &lt;pattern value="([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?"/&gt;
 395     &lt;/type&gt;
 396     &lt;description&gt;
 397       &lt;text&gt;Represents media- or physical-level addresses represented
 398 as a sequence octets, each octet represented by two hexadecimal
 399 numbers.  Octets are separated by colons.  The canonical
 400 representation uses lowercase characters.
 401
 402 In the value set and its semantics, this type is equivalent
 403 to the PhysAddress textual convention of the SMIv2.&lt;/text&gt;
 404     &lt;/description&gt;
 405     &lt;reference&gt;
 406       &lt;text&gt;RFC 2579: Textual Conventions for SMIv2&lt;/text&gt;
 407     &lt;/reference&gt;
 408   &lt;/typedef&gt;
 409   &lt;typedef name="mac-address"&gt;
 410     &lt;type name="string"&gt;
 411       &lt;pattern value="[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}"/&gt;
 412     &lt;/type&gt;
 413     &lt;description&gt;
 414       &lt;text&gt;The mac-address type represents an IEEE 802 MAC address.
 415 The canonical representation uses lowercase characters.
 416
 417 In the value set and its semantics, this type is equivalent
 418 to the MacAddress textual convention of the SMIv2.&lt;/text&gt;
 419     &lt;/description&gt;
 420     &lt;reference&gt;
 421       &lt;text&gt;IEEE 802: IEEE Standard for Local and Metropolitan Area
 422           Networks: Overview and Architecture
 423 RFC 2579: Textual Conventions for SMIv2&lt;/text&gt;
 424     &lt;/reference&gt;
 425   &lt;/typedef&gt;
 426   &lt;typedef name="xpath1.0"&gt;
 427     &lt;type name="string"/&gt;
 428     &lt;description&gt;
 429       &lt;text&gt;This type represents an XPATH 1.0 expression.
 430
 431 When a schema node is defined that uses this type, the
 432 description of the schema node MUST specify the XPath
 433 context in which the XPath expression is evaluated.&lt;/text&gt;
 434     &lt;/description&gt;
 435     &lt;reference&gt;
 436       &lt;text&gt;XPATH: XML Path Language (XPath) Version 1.0&lt;/text&gt;
 437     &lt;/reference&gt;
 438   &lt;/typedef&gt;
 439   &lt;typedef name="hex-string"&gt;
 440     &lt;type name="string"&gt;
 441       &lt;pattern value="([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?"/&gt;
 442     &lt;/type&gt;
 443     &lt;description&gt;
 444       &lt;text&gt;A hexadecimal string with octets represented as hex digits
 445 separated by colons.  The canonical representation uses
 446 lowercase characters.&lt;/text&gt;
 447     &lt;/description&gt;
 448   &lt;/typedef&gt;
 449   &lt;typedef name="uuid"&gt;
 450     &lt;type name="string"&gt;
 451       &lt;pattern value="[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"/&gt;
 452     &lt;/type&gt;
 453     &lt;description&gt;
 454       &lt;text&gt;A Universally Unique IDentifier in the string representation
 455 defined in RFC 4122.  The canonical representation uses
 456 lowercase characters.
 457
 458 The following is an example of a UUID in string representation:
 459 f81d4fae-7dec-11d0-a765-00a0c91e6bf6
 460 &lt;/text&gt;
 461     &lt;/description&gt;
 462     &lt;reference&gt;
 463       &lt;text&gt;RFC 4122: A Universally Unique IDentifier (UUID) URN
 464           Namespace&lt;/text&gt;
 465     &lt;/reference&gt;
 466   &lt;/typedef&gt;
 467   &lt;typedef name="dotted-quad"&gt;
 468     &lt;type name="string"&gt;
 469       &lt;pattern value="(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])"/&gt;
 470     &lt;/type&gt;
 471     &lt;description&gt;
 472       &lt;text&gt;An unsigned 32-bit number expressed in the dotted-quad
 473 notation, i.e., four octets written as decimal numbers
 474 and separated with the '.' (full stop) character.&lt;/text&gt;
 475     &lt;/description&gt;
 476   &lt;/typedef&gt;
 477 &lt;/module&gt;
 478 </data>
 479 </rpc-reply>