yang解读
引用:
对YANG的解读(一) - 简书 (jianshu.com)
1 为什么要有YANG
netconf需要对设备的配置(configuration)和状态(state)做操作,例如编辑配置,获取状态,因此需要一种语言来对configuration和state进行建模,甚至连“操作”也可以通过YANG来建模。建好的模型,最后以XML的形式进行实例化。打个比方,我需要向领导请假,领导说你写个请假单,包含请假人的姓名,请假的起止时间,请假事由和代理人。于是我做了一个表格,包含了上述要求,并根据实际情况填入了真实信息。那么领导的描述,就可以理解为“建模”,而我最后提交的填好内容的表格,就是将模型实例化了。
2 建模需要什么呢
如果要建模,一定需要一些基础架构,然后将要建立的模型用这些基础架构拼接出来。那么YANG提供了哪些架构呢?
2.1 module和submodule
module的header主要是一些描述信息,而body就是data model定义的地方。module可以分为submodule。模块化的好处就是方便引用。
2.2 Data Modeling Basics
这时候要敲敲黑板,因为重点来喽。这里介绍最最基本的四种建模架构。
2.2.1 Leaf Nodes
一个leaf node包含且只包含一个value,可以是数字或是字符串,具体是什么,看关键字"type"后面跟什么。leaf node下面不能挂子节点。
例如:
YANG Example:
leaf host-name {
type string;
description "Hostname for this system";
}
-----------------------
NETCONF XML Example:
<host-name>my.example.com</host-name>
此处用YANG定义了一个名为host-name的leaf,它包含对自己的description,有一个string类型的值。那么当用XML实例化这个leaf的时候,就需要对host-name进行具体的赋值。换句话说,YANG是挖坑的,XML是填坑的,但是XML填坑用的材料的“形状”,要和YANG定义的一样。
2.2.2 Leaf-List Nodes
与上面的Leaf Nodes“一字之差”,多了一个“-list”。可以认为Leaf-List Nodes表示的是一个“数组”,“数组”中的元素的值的type必须保持一致,而且不能重复。
例如:
YANG Example:
leaf-list domain-search {
type string;
description "List of domain names to search";
}
-----------------------
NETCONF XML Example:
<domain-search>high.example.com</domain-search>
<domain-search>low.example.com</domain-search>
<domain-search>everywhere.example.com</domain-search>
和leaf node一样,它也只定义一个value,但是可以有一系列同类型的值。例子中<domain-serarch>的值有多个,但是定义和类型都是统一的。
2.2.3 Container Nodes
“Container”可以翻译成“集装箱”。真正有价值的,是集装箱里面装的货物,而不是集装箱本身。但是如果没有集装箱,那么里面的货物就散了。
Container的作用就是将数据层次化组织起来,呈现出subtree的样式。特别需要注意的是:
(1)一个空的集装箱也是能“卖钱”的,因为毕竟是铁皮做的,但是一个container自身是没有“value”的;
(2)一个集装箱容量是有限的,但是一个container可以装多少node并没有限制,而且这些node可以在leaf/list/leaf-list甚至是container(想起了俄罗斯套娃)中任意选取。
例如:
YANG Example:
container system {
container login {
leaf message {
type string;
description
"Message given at start of login session";
}
}
}
-----------------------
NETCONF XML Example:
<system>
<login>
<message>Good morning</message>
</login>
</system>
container system里面装了一个container login,然后login里面有一个leaf node,就是类型为string的“message”。
2.2.4 List Nodes
一个List node可以包含多个child node,而且这些node可以在leaf/leaf-list/container中任意选取。List必须指明这些child中的一个node为key。
例如:
YANG Example:
list user {
key "name";
leaf name {
type string;
}
leaf full-name {
type string;
}
leaf class {
type string;
}
}
-----------------------
NETCONF XML Example:
<user>
<name>glocks</name>
<full-name>Goldie Locks</full-name>
<class>intruder</class>
</user>
<user>
<name>snowey</name>
<full-name>Snow White</full-name>
<class>free-loader</class>
</user>
<user>
<name>rzell</name>
<full-name>Rapun Zell</full-name>
<class>tower</class>
</user>
定义了一个名为“user”的list,这个list中包含三个leaf:name/full-name/class。其中name被指定为key。实例化的时候,key的值(也就是"name"的值)是必须不同的,其它的值(full-name/class)没有这个要求。随后xml实例化了三个user,都包含YANG定义的name/full-name/class,而且name都是不同的。
2.2.5 Combined Module
RFC中给出了一个综合上述四种node的混合模式的例子如下:
// Contents of "acme-system.yang"
module acme-system {
namespace "http://acme.example.com/system";
prefix "acme";
organization "ACME Inc.";
contact "joe@acme.example.com";
description
"The module for entities implementing the ACME system.";
revision 2007-06-09 {
description "Initial revision.";
}
container system {
leaf host-name {
type string;
description "Hostname for this system";
}
leaf-list domain-search {
type string;
description "List of domain names to search";
}
container login {
leaf message {
type string;
description
"Message given at start of login session";
}
list user {
key "name";
leaf name {
type string;
}
leaf full-name {
type string;
}
leaf class {
type string;
}
}
}
}
}
-----------------------
NETCONF XML Example:
<system>
<host-name>myyang.com</host-name>
<domain-search>high.example.com</domain-search>
<domain-search>low.example.com</domain-search>
<domain-search>everywhere.example.com</domain-search>
<login>
<message>Good Morning</message>
<user>
<name>glocks</name>
<full-name>Goldie Locks</full-name>
<class>intruder</class>
</user>
<user>
<name>snowey</name>
<full-name>Snow White</full-name>
<class>free-loader</class>
</user>
<user>
<name>rzell</name>
<full-name>Rapun Zell</full-name>