ordmodels/device/src/main/yang/openconfig-extensions@2017-04-11.yang

   1 module openconfig-extensions {
   2   yang-version 1;
   3   namespace "http://openconfig.net/yang/openconfig-ext";
   4   prefix oc-ext;
   5
   6   organization
   7     "OpenConfig working group";
   8   contact
   9     "OpenConfig working group
  10      www.openconfig.net";
  11   description
  12     "This module provides extensions to the YANG language to allow
  13      OpenConfig specific functionality and meta-data to be defined.";
  14
  15   revision 2017-04-11 {
  16     description
  17       "rename password type to 'hashed' and clarify description";
  18     reference
  19       "0.3.0";
  20   }
  21   revision 2017-01-29 {
  22     description
  23       "Added extension for annotating encrypted values.";
  24     reference
  25       "0.2.0";
  26   }
  27   revision 2015-10-09 {
  28     description
  29       "Initial OpenConfig public release";
  30     reference
  31       "0.1.0";
  32   }
  33
  34   extension openconfig-version {
  35     argument semver {
  36       yin-element false;
  37     }
  38     description
  39       "The OpenConfig version number for the module. This is
  40        expressed as a semantic version number of the form:
  41         x.y.z
  42        where:
  43         * x corresponds to the major version,
  44         * y corresponds to a minor version,
  45         * z corresponds to a patch version.
  46        This version corresponds to the model file within which it is
  47        defined, and does not cover the whole set of OpenConfig models.
  48        Where several modules are used to build up a single block of
  49        functionality, the same module version is specified across each
  50        file that makes up the module.
  51
  52        A major version number of 0 indicates that this model is still
  53        in development (whether within OpenConfig or with industry
  54        partners), and is potentially subject to change.
  55
  56        Following a release of major version 1, all modules will
  57        increment major revision number where backwards incompatible
  58        changes to the model are made.
  59
  60        The minor version is changed when features are added to the
  61        model that do not impact current clients use of the model.
  62
  63        The patch-level version is incremented when non-feature changes
  64        (such as bugfixes or clarifications to human-readable
  65        descriptions that do not impact model functionality) are made
  66        that maintain backwards compatibility.
  67
  68        The version number is stored in the module meta-data.";
  69   }
  70
  71   extension openconfig-hashed-value {
  72     description
  73       "This extension provides an annotation on schema nodes to
  74        indicate that the corresponding value should be stored and
  75        reported in hashed form.
  76
  77        Hash algorithms are by definition not reversible. Clients
  78        reading the configuration or applied configuration for the node
  79        should expect to receive only the hashed value. Values written
  80        in cleartext will be hashed. This annotation may be used on
  81        nodes such as secure passwords in which the device never reports
  82        a cleartext value, even if the input is provided as cleartext.";
  83   }
  84 }