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