1674d38e062684b3067ef1c6137677d93bbf1cea
[oam.git] / features / devicemanager / x-ran / ru-fh / provider / src / main / yang / 1-0-0 / readme.txt
1 xRAN Forum YANG Models
2
3 xRAN has defined an open, interoperable and efficient fronthaul interface.
4 The definition of this interface includes the xRAN control, user and
5 synchronization (CUS) plane specification .
6
7 To complement the CUS plane specification, xRAN has also defined the management
8 plane specification . Significantly, the management plane specification uses
9 NETCONF/YANG as the network management protocol and data modelling language.
10
11 The M-Plane specification describes how to use a set of xRAN defined YANG models
12 for managing the xRAN defined RU. This zip file contains the YANG models for
13 the xRAN defined Radio Unit (RU).
14
15 Directory of YANG models
16
17 All revisions of YANG models are available in this directory, with the revision
18 being embedded in the path for a particular model. For example all v1.0.0 models
19 are available using the directory path 
20
21 http://www.xran.org/resources/yang/1-0-0/
22
23 Under the directory, the is a zip file that contains several sub-directories
24 used to organize the models according to the functionality they support:
25
26          Interfaces: Covering models for handling the RU’s Ethernet and IP
27                      interfaces
28          Operations: Covering models for operational aspects, including S/W,
29                      performance and file management
30          Radio:      Covering models used to support the CU Plane lower PHY
31                      functionality
32          Sync:       Covering models for synchronisation, including GNSS, PTP
33                      and SyncE
34          System:     Covering models for hardware management, NETCONF
35                      supervision, user account management and fan operation
36
37 Validation
38
39 The YANG files have been tested for compilation with pyang version 1.7.4.
40
41 Known Issues
42
43 A list of functionalities not currently supported by these YANG models is
44 defined in the M-Plane specification.
45
46 Future Revisions
47
48 Revisions to these YANG models are expected to be made to correct errors and
49 enable support for new functionalities. The YANG revisions statement will be
50 used to describe those changes to the YANG model that are backwards compatible.
51 Backwards incompatible changes will be addressed by using a major version number
52 as part of the model name and namespace.