Brocade Network OS YANG Reference Manual v4.1.1 - Manual (Page 13)

Network OS YANG Reference Manual 1
53-1003230-01
Chapter
1
Using YANG
In this chapter
• Yang overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
• Using the Network OS YANG Reference Manual . . . . . . . . . . . . . . . . . . . . . . . 1
Yang overview
YANG is a data modeling language. It is used to model configuration and state data for
manipulation by the Network Configuration Protocol (NETCONF) using NETCONF remote procedure
calls (RPCs).
Refer to RFC 6020, YANG - A Data Modeling Language for the Network Configuration Protocol
(NETCONF) for full; details of how to use YANG, and for a reference of all the features of the YANG
language.
Using the Network OS YANG Reference Manual
This manual provides a reference for YANG modules supported by Network OS v4.1.0.
Each module provides a data model for a specific part of the system. It models the data using one
or more of the following entities:
• Top-level nodes and their subtrees
• Subtrees that augment nodes in other YANG modules
• Custom RPCs
• Custom actions that make use of the proprietary action mechanism
For each module, this manual provides a high-level description of what the module does. It also
provides the structure of each top-level node, external augmentation, custom RPC, and action.
The pyang command with the -f tree option is used to illustrate the YANG code. This utility resolves
the uses and augments statements to provide an easy-to-read view of the structure of the YANG
code. The following example shows part of the module.
module:
+--rw interface
| +--rw fc-port [name]
| +--rw name interface-type
| +--rw fc-speed-cfg? fc-speed-cfg-type
| +--rw fill-word? fc-fillword-cfg-type
| +--rw long-distance? fc-long-distance-cfg-type
| +--rw vc-link-init? fc-vc-link-init-cfg-type
| +--rw desire-distance? desire-distance-type
| +--rw isl-r_rdy-mode? empty