Module 6: YANG Tutorial - part 2

YANG Tutorial – part 2
Presented by Tail-f

MAY 27, 2013 2©2013 TAIL-F all rights reserved
TUTORIAL: NETCONF AND YANG
Advanced YANG Statements

Must Statement
Restricts valid values by Xpath 1.0 expression
container timeout {
leaf access-timeout {
description "Maximum time without server response";
units seconds;
mandatory true;
type uint32;
}
leaf retry-timer {
description "Period to retry operation";
units seconds;
type uint32;
must ”current() < ../access-timeout" {
error-app-tag retry-timer-invalid;
error-message "The retry timer must be "
+ "less than the access timeout";
}
}
}

Must Statement
leaf interface-group-name {
type string {
length "1..31";
pattern "[a-zA-Z][a-zA-Z0-9_-]*";
}
must "not(/sys:sys/interface[name = current()])" {
error-message ”Must be different from all interface names";
tailf:dependency "/sys:sys/interface/name";
}
}

Must Statement
leaf max-weight {
type uint32 {
range "0..1000";
}
default 100;
must "sum(/sys:sys/interface[enabled = 'true']/weight)
< current()" {
error-message "The total weight exceeds the configured
max weight";
}
}

Augment Statement
augment /sys:system/sys:user {
leaf expire {
type yang:date-and-time;
}
}
user
name classfull-nameuid expire
+
Default

When Statement
augment /sys:system/sys:user {
when ”sys:class = ‘wheel’";
leaf shell {
type string;
}
}
user
name classfull-nameuid expire
+
Default
shell
When

Choice Statement
Choice allows one of several
alternatives
choice transfer-method {
leaf transfer-interval {
description "Frequency at which file transfer happens";
type uint16 {
range "15 .. 2880";
}
units minutes;
}
leaf transfer-on-commit {
description "Transfer after each commit";
type empty;
}
}
transfer-interval
transfer-on-commit
transfer-method

Choice Statement
Each alternative may consist of multiple definitions
• Either as a named or anonymous group
choice counters {
case four-counters {
leaf threshold {…}
leaf ignore-count {…}
leaf ignore-time {…}
leaf reset-time {…}
}
container warning-only {
…
}
default four-counters;
}

Identity Statement
Identities for modeling families of related enumeration constants
module phys-if {
…
identity ethernet {
description
"Ethernet family of PHY
interfaces";
}
identity eth-1G {
base ethernet;
description "1 GigEth";
}
identity eth-10G {
base ethernet;
}
module newer {
…
identity eth-40G {
base phys-if:ethernet;
}
identity eth-100G {
base phys-if:ethernet;
}
…
leaf eth-type {
type identityref {
base ”phys-if:ethernet";
}
}

Feature Statement
Mark data as conditional
feature has-local-disk {
description
“System has a local file
system that can be used
for storing log files”;
}
container system {
container logging {
if-feature has-local-disk;
presence “Logging enabled”;
leaf buffer-size {
type filesize;
}
}
}
system
logging
buffer-size
Feature, Presence
The features supported by a system are
meant to stay relatively constant. Adding
a feature is comparable to a hardware
upgrade.

Deviations
Systems should conform to standard YANG models
• Still, if a device can’t, that can be properly declared
deviation /base:system/base:user/base:type {
deviate add {
default "admin"; // new users are 'admin' by default
}
}
deviation /base:system/base:name-server {
deviate replace {
max-elements 3;
}
}

YANG Modeling Strategy

Constraints
• On-board XPATH parser not required
• XPATH is more formal than English, that’s all
• Debate: “Configuration validity must not depend on state”
• Are operators right?
• What are the implications?
• min-elements
• max-elements
• range
• key/unique
• leafref
• must
• when

Structure
• Model to mimic an existing interface?
• Model for which interfaces?
• YANG for NETCONF only?
• All interfaces uses the YANG model?
• Multiple models with transformations?
• Multiple models that allow writing?
• What goes in each namespace?
• One, a few or many namespaces?
• No configuration inside operational data
• SNMP transient configuration

So what is configuration?
• What is in the factory default?
• Any probing at system boot?
• Do you want pre-provisioning?
• Do you want to support rollbacks?
• Inserting a board, is that an act of configuration?
• Do you need spontaneous reconfiguration?
• Where does the configuration data originate from?

VersioningYANG Modules
You must / must not:
• Add a revision statement on
top
• Update organization, contact,
etc
• Do not rename module or
namespace
• Do not remove obsolete
definitions
• Do not reorder data
definitions
You may:
• Add enum, bits, typedef,
grouping, rpc, notification,
extension, feature, identity,
case
• Add non-mandatory data
definitions
• Add mandatory data
definitions within new if-
feature statements
 RFC 6020 sec 10

VersioningYANG Modules (cont’d)
You may:
• Add or update a status
statement: current 
deprecated  obsolete
• Expand allowed range, length,
pattern
• Add a default
(but not change it!)
• Add units, add or update a
reference
You may:
• Change mandatory to false (or
remove it)
• Remove or relax min- & max-
elements
• Add or clarify a description
without changing the
semantics
• Change state data to optional
configuration
• Remove an if-feature

IETF Modeling Recommendations
• Describe
• Module, security considerations, references, definitions, …
• Top level
• Only one data definition (typ. container) on top level
• Top level data definitions optional
• Enumerations that grow
• Use identityref instead of enumeration

IETF Modeling Recommendations
• Specific types
• Use ranges, length restrictions, patterns
• Do not use signed types unless negative values needed
• Standard types
• When possible, use standard types,
e.g. ‘yang-types’ defined in RFC 6021
• Make your own reusable ‘type modules’

Yin, YANG and YANG Extensions

Yin – the XML representation of YANG
YANG 日
container dhcp {
leaf defaultLeaseTime {
type xs:duration;
default PT600S;
}
leaf maxLeaseTime {
type xs:duration;
default PT7200S;
}
leaf logFacility {
type loglevel;
default local7;
}
Yin 月
<container name="dhcp">
<leaf name="defaultLeaseTime">
<type name="xs:duration"/>
<default value="PT600S"/>
</leaf>
<leaf name="maxLeaseTime">
<type name="xs:duration"/>
<default value="PT7200S”/>
</leaf>
<leaf name="logFacility">
<type name="loglevel"/>
<default value="local7"/>
</leaf>
Lossless
Lossless

YANG Extensions - Prototype
module prototype {
namespace "http://tail-f.com…
prefix prototype;
extension create {
argument keylist;
}
extension value {
argument value;
}
extension keylist-value {
argument keylist-value;
}
}
module xyz {
list y {
config false;
tailf:cdb-oper;
prototype:create "b=1,c=0";
key "b c";
leaf b { type int32; }
leaf c { type int32; }
leaf d {
type string;
prototype:keylist-value
"b=1,c=0,cool";
prototype:keylist-value
"b=6,c=1,green";
}

YANG Extensions - Prototype
c "/xyz:x/xyz:y{1 0}"
s "/xyz:x/xyz:y{1 0}/xyz:d" "cool"
s "/xyz:x/xyz:y{6 1}/xyz:d" "green"
ubuntu# show x
B C D
-------------
1 0 cool
6 0 -
6 1 green
Prototype
.yang
XYZ
.yang
XYZ
init
data
XYZ
pyang
confdc
prototype.py

Example:
Router Device Model (part of)

Example: Quagga Types
submodule quagga_common {
belongs-to quagga {
prefix quagga;
}
…
include quagga_top;
typedef PrefixLengthIPv4 {
type uint8 { range 0 .. 32; }
}
…
grouping inetNetworkAddressIPv4 {
leaf address {
type inet:ipv4-address;
mandatory true;
}
leaf prefix-length {
type PrefixLengthIPv4;
mandatory true;
}
}
typedef MacAddressType {
type string {
length 17;
pattern "([0-9a-fA-F][0-9a-fA-F]:){5}
([0-9a-fA-F][0-9a-fA-F])";
}
}
typedef ACLLowRangeType {
type uint32 { range 1 .. 99; }
}
typedef ACLHighRangeType {
type uint32 { range 1300 .. 1999; }
}
typedef ACLExtType {
type union {
type ACLExtLowRangeType;
type ACLExtHighRangeType;
}
}
typedef InfiniteType {
type enumeration {
enum infinite;
}
}
typedef DateTimeInfiniteType {
type union {
type yang:date-and-time;
type InfiniteType;
}
}

Example: Quagga Interface Configuration
submodule zebra_confd_if {
belongs-to quagga {
prefix quagga;
}
include confd_top;
include confd_common;
typedef BandwidthRangeType {
type uint64 { range "1 .. 10000000000"; }
}
augment "/system/interface" {
leaf bandwidth {
type BandwidthRangeType;
}
leaf link-detect {
type boolean;
default false;
}
leaf multicast {
type MulticastType;
default if-default;
}
leaf up {
type boolean;
default true;
}
}
}
submodule zebra_confd_if_ip {
belongs-to quagga {
prefix quagga;
}
import ietf-inet-types {
prefix inet;
}
include confd_top;
augment "/system/interface/ip" {
list address {
key "address prefix-length";
leaf address {
type inet:ipv4-address;
}
leaf prefix-length {
type PrefixLengthIPv4;
}
leaf label {
type string;
}
}
}
}

Example: Quagga Status & Notification
submodule zebra_confd_stats_memory {
belongs-to quagga {
prefix quagga;
}
import tailf-common {
prefix tailf;
}
include confd_top;
augment "/system/stats/memory" {
container zebra {
config false;
tailf:callpoint "zebraGetMemory";
uses memoryStatusType;
}
}
}
notification saExpired {
leaf tunnelName {
type leafref {
path "/system/vpn/ipsec/tunnel/name";
}
mandatory true;
}
leaf spi {
type int64;
mandatory true;
}
}

Example:
Q-in-Q Service Model

Example: Q-in-Q Service Model (complete)
module qinq-service {
namespace "http://com/example/qinq-service";
prefix qinq;
import tailf-common { prefix tailf; }
import tailf-ncs { prefix ncs; }
list qinq {
key name;
leaf name { type string; }
leaf s-vlan {
mandatory true;
type uint32 { range 1..4094; }
}
must "not (/qt:qinq[name != current()/name]
[s-vlan = current()/s-vlan])” {
error-message "The s-vlan must be unique within
the network”
}
list edge-switch {
key switch;
leaf switch {
type leafref {path /ncs:devices/ncs:device/ncs:name;}
}
list edge-interface {
key interface;
leaf interface { type string; }
leaf-list c-vlan {
type uint32 { range 1..4094; }
}
}
leaf-list trunk-interface {
min-elements 1;
type string;
}
}
list core-switch {
key switch;
leaf switch {
type leafref {path /ncs:devices/ncs:device/ncs:name;}
}
leaf-list trunk-interface {
min-elements 1;
type string;
}
}
}
}

Module 6: YANG Tutorial - part 2

Module 6: YANG Tutorial - part 2

More Related Content

What's hot (20)

Viewers also liked (12)

Similar to Module 6: YANG Tutorial - part 2 (20)

Recently uploaded (20)

Module 6: YANG Tutorial - part 2