vnfs/TestVNF/netconftemplates/netconftemplates/ietf-inet-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-inet-types"
   4         xmlns="urn:ietf:params:xml:ns:yang:yin:1"
   5         xmlns:inet="urn:ietf:params:xml:ns:yang:ietf-inet-types"&gt;
   6   &lt;namespace uri="urn:ietf:params:xml:ns:yang:ietf-inet-types"/&gt;
   7   &lt;prefix value="inet"/&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 for Internet addresses and related things.
  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 - ip-address-no-zone
  45 - ipv4-address-no-zone
  46 - ipv6-address-no-zone&lt;/text&gt;
  47     &lt;/description&gt;
  48     &lt;reference&gt;
  49       &lt;text&gt;RFC 6991: Common YANG Data Types&lt;/text&gt;
  50     &lt;/reference&gt;
  51   &lt;/revision&gt;
  52   &lt;revision date="2010-09-24"&gt;
  53     &lt;description&gt;
  54       &lt;text&gt;Initial revision.&lt;/text&gt;
  55     &lt;/description&gt;
  56     &lt;reference&gt;
  57       &lt;text&gt;RFC 6021: Common YANG Data Types&lt;/text&gt;
  58     &lt;/reference&gt;
  59   &lt;/revision&gt;
  60   &lt;typedef name="ip-version"&gt;
  61     &lt;type name="enumeration"&gt;
  62       &lt;enum name="unknown"&gt;
  63         &lt;value value="0"/&gt;
  64         &lt;description&gt;
  65           &lt;text&gt;An unknown or unspecified version of the Internet
  66 protocol.&lt;/text&gt;
  67         &lt;/description&gt;
  68       &lt;/enum&gt;
  69       &lt;enum name="ipv4"&gt;
  70         &lt;value value="1"/&gt;
  71         &lt;description&gt;
  72           &lt;text&gt;The IPv4 protocol as defined in RFC 791.&lt;/text&gt;
  73         &lt;/description&gt;
  74       &lt;/enum&gt;
  75       &lt;enum name="ipv6"&gt;
  76         &lt;value value="2"/&gt;
  77         &lt;description&gt;
  78           &lt;text&gt;The IPv6 protocol as defined in RFC 2460.&lt;/text&gt;
  79         &lt;/description&gt;
  80       &lt;/enum&gt;
  81     &lt;/type&gt;
  82     &lt;description&gt;
  83       &lt;text&gt;This value represents the version of the IP protocol.
  84
  85 In the value set and its semantics, this type is equivalent
  86 to the InetVersion textual convention of the SMIv2.&lt;/text&gt;
  87     &lt;/description&gt;
  88     &lt;reference&gt;
  89       &lt;text&gt;RFC  791: Internet Protocol
  90 RFC 2460: Internet Protocol, Version 6 (IPv6) Specification
  91 RFC 4001: Textual Conventions for Internet Network Addresses&lt;/text&gt;
  92     &lt;/reference&gt;
  93   &lt;/typedef&gt;
  94   &lt;typedef name="dscp"&gt;
  95     &lt;type name="uint8"&gt;
  96       &lt;range value="0..63"/&gt;
  97     &lt;/type&gt;
  98     &lt;description&gt;
  99       &lt;text&gt;The dscp type represents a Differentiated Services Code Point
 100 that may be used for marking packets in a traffic stream.
 101 In the value set and its semantics, this type is equivalent
 102 to the Dscp textual convention of the SMIv2.&lt;/text&gt;
 103     &lt;/description&gt;
 104     &lt;reference&gt;
 105       &lt;text&gt;RFC 3289: Management Information Base for the Differentiated
 106           Services Architecture
 107 RFC 2474: Definition of the Differentiated Services Field
 108           (DS Field) in the IPv4 and IPv6 Headers
 109 RFC 2780: IANA Allocation Guidelines For Values In
 110           the Internet Protocol and Related Headers&lt;/text&gt;
 111     &lt;/reference&gt;
 112   &lt;/typedef&gt;
 113   &lt;typedef name="ipv6-flow-label"&gt;
 114     &lt;type name="uint32"&gt;
 115       &lt;range value="0..1048575"/&gt;
 116     &lt;/type&gt;
 117     &lt;description&gt;
 118       &lt;text&gt;The ipv6-flow-label type represents the flow identifier or Flow
 119 Label in an IPv6 packet header that may be used to
 120 discriminate traffic flows.
 121
 122 In the value set and its semantics, this type is equivalent
 123 to the IPv6FlowLabel textual convention of the SMIv2.&lt;/text&gt;
 124     &lt;/description&gt;
 125     &lt;reference&gt;
 126       &lt;text&gt;RFC 3595: Textual Conventions for IPv6 Flow Label
 127 RFC 2460: Internet Protocol, Version 6 (IPv6) Specification&lt;/text&gt;
 128     &lt;/reference&gt;
 129   &lt;/typedef&gt;
 130   &lt;typedef name="port-number"&gt;
 131     &lt;type name="uint16"&gt;
 132       &lt;range value="0..65535"/&gt;
 133     &lt;/type&gt;
 134     &lt;description&gt;
 135       &lt;text&gt;The port-number type represents a 16-bit port number of an
 136 Internet transport-layer protocol such as UDP, TCP, DCCP, or
 137 SCTP.  Port numbers are assigned by IANA.  A current list of
 138 all assignments is available from &amp;lt;http://www.iana.org/&amp;gt;.
 139
 140 Note that the port number value zero is reserved by IANA.  In
 141 situations where the value zero does not make sense, it can
 142 be excluded by subtyping the port-number type.
 143 In the value set and its semantics, this type is equivalent
 144 to the InetPortNumber textual convention of the SMIv2.&lt;/text&gt;
 145     &lt;/description&gt;
 146     &lt;reference&gt;
 147       &lt;text&gt;RFC  768: User Datagram Protocol
 148 RFC  793: Transmission Control Protocol
 149 RFC 4960: Stream Control Transmission Protocol
 150 RFC 4340: Datagram Congestion Control Protocol (DCCP)
 151 RFC 4001: Textual Conventions for Internet Network Addresses&lt;/text&gt;
 152     &lt;/reference&gt;
 153   &lt;/typedef&gt;
 154   &lt;typedef name="as-number"&gt;
 155     &lt;type name="uint32"/&gt;
 156     &lt;description&gt;
 157       &lt;text&gt;The as-number type represents autonomous system numbers
 158 which identify an Autonomous System (AS).  An AS is a set
 159 of routers under a single technical administration, using
 160 an interior gateway protocol and common metrics to route
 161 packets within the AS, and using an exterior gateway
 162 protocol to route packets to other ASes.  IANA maintains
 163 the AS number space and has delegated large parts to the
 164 regional registries.
 165
 166 Autonomous system numbers were originally limited to 16
 167 bits.  BGP extensions have enlarged the autonomous system
 168 number space to 32 bits.  This type therefore uses an uint32
 169 base type without a range restriction in order to support
 170 a larger autonomous system number space.
 171
 172 In the value set and its semantics, this type is equivalent
 173 to the InetAutonomousSystemNumber textual convention of
 174 the SMIv2.&lt;/text&gt;
 175     &lt;/description&gt;
 176     &lt;reference&gt;
 177       &lt;text&gt;RFC 1930: Guidelines for creation, selection, and registration
 178           of an Autonomous System (AS)
 179 RFC 4271: A Border Gateway Protocol 4 (BGP-4)
 180 RFC 4001: Textual Conventions for Internet Network Addresses
 181 RFC 6793: BGP Support for Four-Octet Autonomous System (AS)
 182           Number Space&lt;/text&gt;
 183     &lt;/reference&gt;
 184   &lt;/typedef&gt;
 185   &lt;typedef name="ip-address"&gt;
 186     &lt;type name="union"&gt;
 187       &lt;type name="inet:ipv4-address"/&gt;
 188       &lt;type name="inet:ipv6-address"/&gt;
 189     &lt;/type&gt;
 190     &lt;description&gt;
 191       &lt;text&gt;The ip-address type represents an IP address and is IP
 192 version neutral.  The format of the textual representation
 193 implies the IP version.  This type supports scoped addresses
 194 by allowing zone identifiers in the address format.&lt;/text&gt;
 195     &lt;/description&gt;
 196     &lt;reference&gt;
 197       &lt;text&gt;RFC 4007: IPv6 Scoped Address Architecture&lt;/text&gt;
 198     &lt;/reference&gt;
 199   &lt;/typedef&gt;
 200   &lt;typedef name="ipv4-address"&gt;
 201     &lt;type name="string"&gt;
 202       &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])(%[\p{N}\p{L}]+)?"/&gt;
 203     &lt;/type&gt;
 204     &lt;description&gt;
 205       &lt;text&gt;The ipv4-address type represents an IPv4 address in
 206 dotted-quad notation.  The IPv4 address may include a zone
 207 index, separated by a % sign.
 208
 209 The zone index is used to disambiguate identical address
 210 values.  For link-local addresses, the zone index will
 211 typically be the interface index number or the name of an
 212 interface.  If the zone index is not present, the default
 213 zone of the device will be used.
 214
 215 The canonical format for the zone index is the numerical
 216 format&lt;/text&gt;
 217     &lt;/description&gt;
 218   &lt;/typedef&gt;
 219   &lt;typedef name="ipv6-address"&gt;
 220     &lt;type name="string"&gt;
 221       &lt;pattern value="((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?"/&gt;
 222       &lt;pattern value="(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?"/&gt;
 223     &lt;/type&gt;
 224     &lt;description&gt;
 225       &lt;text&gt;The ipv6-address type represents an IPv6 address in full,
 226 mixed, shortened, and shortened-mixed notation.  The IPv6
 227 address may include a zone index, separated by a % sign.
 228
 229 The zone index is used to disambiguate identical address
 230 values.  For link-local addresses, the zone index will
 231 typically be the interface index number or the name of an
 232 interface.  If the zone index is not present, the default
 233 zone of the device will be used.
 234
 235 The canonical format of IPv6 addresses uses the textual
 236 representation defined in Section 4 of RFC 5952.  The
 237 canonical format for the zone index is the numerical
 238 format as described in Section 11.2 of RFC 4007.&lt;/text&gt;
 239     &lt;/description&gt;
 240     &lt;reference&gt;
 241       &lt;text&gt;RFC 4291: IP Version 6 Addressing Architecture
 242 RFC 4007: IPv6 Scoped Address Architecture
 243 RFC 5952: A Recommendation for IPv6 Address Text
 244           Representation&lt;/text&gt;
 245     &lt;/reference&gt;
 246   &lt;/typedef&gt;
 247   &lt;typedef name="ip-address-no-zone"&gt;
 248     &lt;type name="union"&gt;
 249       &lt;type name="inet:ipv4-address-no-zone"/&gt;
 250       &lt;type name="inet:ipv6-address-no-zone"/&gt;
 251     &lt;/type&gt;
 252     &lt;description&gt;
 253       &lt;text&gt;The ip-address-no-zone type represents an IP address and is
 254 IP version neutral.  The format of the textual representation
 255 implies the IP version.  This type does not support scoped
 256 addresses since it does not allow zone identifiers in the
 257 address format.&lt;/text&gt;
 258     &lt;/description&gt;
 259     &lt;reference&gt;
 260       &lt;text&gt;RFC 4007: IPv6 Scoped Address Architecture&lt;/text&gt;
 261     &lt;/reference&gt;
 262   &lt;/typedef&gt;
 263   &lt;typedef name="ipv4-address-no-zone"&gt;
 264     &lt;type name="inet:ipv4-address"&gt;
 265       &lt;pattern value="[0-9\.]*"/&gt;
 266     &lt;/type&gt;
 267     &lt;description&gt;
 268       &lt;text&gt;An IPv4 address without a zone index.  This type, derived from
 269 ipv4-address, may be used in situations where the zone is
 270 known from the context and hence no zone index is needed.&lt;/text&gt;
 271     &lt;/description&gt;
 272   &lt;/typedef&gt;
 273   &lt;typedef name="ipv6-address-no-zone"&gt;
 274     &lt;type name="inet:ipv6-address"&gt;
 275       &lt;pattern value="[0-9a-fA-F:\.]*"/&gt;
 276     &lt;/type&gt;
 277     &lt;description&gt;
 278       &lt;text&gt;An IPv6 address without a zone index.  This type, derived from
 279 ipv6-address, may be used in situations where the zone is
 280 known from the context and hence no zone index is needed.&lt;/text&gt;
 281     &lt;/description&gt;
 282     &lt;reference&gt;
 283       &lt;text&gt;RFC 4291: IP Version 6 Addressing Architecture
 284 RFC 4007: IPv6 Scoped Address Architecture
 285 RFC 5952: A Recommendation for IPv6 Address Text
 286           Representation&lt;/text&gt;
 287     &lt;/reference&gt;
 288   &lt;/typedef&gt;
 289   &lt;typedef name="ip-prefix"&gt;
 290     &lt;type name="union"&gt;
 291       &lt;type name="inet:ipv4-prefix"/&gt;
 292       &lt;type name="inet:ipv6-prefix"/&gt;
 293     &lt;/type&gt;
 294     &lt;description&gt;
 295       &lt;text&gt;The ip-prefix type represents an IP prefix and is IP
 296 version neutral.  The format of the textual representations
 297 implies the IP version.&lt;/text&gt;
 298     &lt;/description&gt;
 299   &lt;/typedef&gt;
 300   &lt;typedef name="ipv4-prefix"&gt;
 301     &lt;type name="string"&gt;
 302       &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])/(([0-9])|([1-2][0-9])|(3[0-2]))"/&gt;
 303     &lt;/type&gt;
 304     &lt;description&gt;
 305       &lt;text&gt;The ipv4-prefix type represents an IPv4 address prefix.
 306 The prefix length is given by the number following the
 307 slash character and must be less than or equal to 32.
 308
 309 A prefix length value of n corresponds to an IP address
 310 mask that has n contiguous 1-bits from the most
 311 significant bit (MSB) and all other bits set to 0.
 312
 313 The canonical format of an IPv4 prefix has all bits of
 314 the IPv4 address set to zero that are not part of the
 315 IPv4 prefix.&lt;/text&gt;
 316     &lt;/description&gt;
 317   &lt;/typedef&gt;
 318   &lt;typedef name="ipv6-prefix"&gt;
 319     &lt;type name="string"&gt;
 320       &lt;pattern value="((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))"/&gt;
 321       &lt;pattern value="(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(/.+)"/&gt;
 322     &lt;/type&gt;
 323     &lt;description&gt;
 324       &lt;text&gt;The ipv6-prefix type represents an IPv6 address prefix.
 325 The prefix length is given by the number following the
 326 slash character and must be less than or equal to 128.
 327
 328 A prefix length value of n corresponds to an IP address
 329 mask that has n contiguous 1-bits from the most
 330 significant bit (MSB) and all other bits set to 0.
 331
 332 The IPv6 address should have all bits that do not belong
 333 to the prefix set to zero.
 334
 335 The canonical format of an IPv6 prefix has all bits of
 336 the IPv6 address set to zero that are not part of the
 337 IPv6 prefix.  Furthermore, the IPv6 address is represented
 338 as defined in Section 4 of RFC 5952.&lt;/text&gt;
 339     &lt;/description&gt;
 340     &lt;reference&gt;
 341       &lt;text&gt;RFC 5952: A Recommendation for IPv6 Address Text
 342           Representation&lt;/text&gt;
 343     &lt;/reference&gt;
 344   &lt;/typedef&gt;
 345   &lt;typedef name="domain-name"&gt;
 346     &lt;type name="string"&gt;
 347       &lt;length value="1..253"/&gt;
 348       &lt;pattern value="((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\."/&gt;
 349     &lt;/type&gt;
 350     &lt;description&gt;
 351       &lt;text&gt;The domain-name type represents a DNS domain name.  The
 352 name SHOULD be fully qualified whenever possible.
 353
 354 Internet domain names are only loosely specified.  Section
 355 3.5 of RFC 1034 recommends a syntax (modified in Section
 356 2.1 of RFC 1123).  The pattern above is intended to allow
 357 for current practice in domain name use, and some possible
 358 future expansion.  It is designed to hold various types of
 359 domain names, including names used for A or AAAA records
 360 (host names) and other records, such as SRV records.  Note
 361 that Internet host names have a stricter syntax (described
 362 in RFC 952) than the DNS recommendations in RFCs 1034 and
 363 1123, and that systems that want to store host names in
 364 schema nodes using the domain-name type are recommended to
 365 adhere to this stricter standard to ensure interoperability.
 366
 367 The encoding of DNS names in the DNS protocol is limited
 368 to 255 characters.  Since the encoding consists of labels
 369 prefixed by a length bytes and there is a trailing NULL
 370 byte, only 253 characters can appear in the textual dotted
 371 notation.
 372
 373 The description clause of schema nodes using the domain-name
 374 type MUST describe when and how these names are resolved to
 375 IP addresses.  Note that the resolution of a domain-name value
 376 may require to query multiple DNS records (e.g., A for IPv4
 377 and AAAA for IPv6).  The order of the resolution process and
 378 which DNS record takes precedence can either be defined
 379 explicitly or may depend on the configuration of the
 380 resolver.
 381
 382 Domain-name values use the US-ASCII encoding.  Their canonical
 383 format uses lowercase US-ASCII characters.  Internationalized
 384 domain names MUST be A-labels as per RFC 5890.&lt;/text&gt;
 385     &lt;/description&gt;
 386     &lt;reference&gt;
 387       &lt;text&gt;RFC  952: DoD Internet Host Table Specification
 388 RFC 1034: Domain Names - Concepts and Facilities
 389 RFC 1123: Requirements for Internet Hosts -- Application
 390           and Support
 391 RFC 2782: A DNS RR for specifying the location of services
 392           (DNS SRV)
 393 RFC 5890: Internationalized Domain Names in Applications
 394           (IDNA): Definitions and Document Framework&lt;/text&gt;
 395     &lt;/reference&gt;
 396   &lt;/typedef&gt;
 397   &lt;typedef name="host"&gt;
 398     &lt;type name="union"&gt;
 399       &lt;type name="inet:ip-address"/&gt;
 400       &lt;type name="inet:domain-name"/&gt;
 401     &lt;/type&gt;
 402     &lt;description&gt;
 403       &lt;text&gt;The host type represents either an IP address or a DNS
 404 domain name.&lt;/text&gt;
 405     &lt;/description&gt;
 406   &lt;/typedef&gt;
 407   &lt;typedef name="uri"&gt;
 408     &lt;type name="string"/&gt;
 409     &lt;description&gt;
 410       &lt;text&gt;The uri type represents a Uniform Resource Identifier
 411 (URI) as defined by STD 66.
 412
 413 Objects using the uri type MUST be in US-ASCII encoding,
 414 and MUST be normalized as described by RFC 3986 Sections
 415 6.2.1, 6.2.2.1, and 6.2.2.2.  All unnecessary
 416 percent-encoding is removed, and all case-insensitive
 417 characters are set to lowercase except for hexadecimal
 418 digits, which are normalized to uppercase as described in
 419 Section 6.2.2.1.
 420
 421 The purpose of this normalization is to help provide
 422 unique URIs.  Note that this normalization is not
 423 sufficient to provide uniqueness.  Two URIs that are
 424 textually distinct after this normalization may still be
 425 equivalent.
 426
 427 Objects using the uri type may restrict the schemes that
 428 they permit.  For example, 'data:' and 'urn:' schemes
 429 might not be appropriate.
 430
 431 A zero-length URI is not a valid URI.  This can be used to
 432 express 'URI absent' where required.
 433
 434 In the value set and its semantics, this type is equivalent
 435 to the Uri SMIv2 textual convention defined in RFC 5017.&lt;/text&gt;
 436     &lt;/description&gt;
 437     &lt;reference&gt;
 438       &lt;text&gt;RFC 3986: Uniform Resource Identifier (URI): Generic Syntax
 439 RFC 3305: Report from the Joint W3C/IETF URI Planning Interest
 440           Group: Uniform Resource Identifiers (URIs), URLs,
 441           and Uniform Resource Names (URNs): Clarifications
 442           and Recommendations
 443 RFC 5017: MIB Textual Conventions for Uniform Resource
 444           Identifiers (URIs)&lt;/text&gt;
 445     &lt;/reference&gt;
 446   &lt;/typedef&gt;
 447 &lt;/module&gt;
 448 </data>
 449 </rpc-reply>