1 module xran-file-management {
3 namespace "urn:xran:file-management:1.0";
4 prefix "xran-file-mgmt";
7 organization "xRAN Forum";
13 "This module defines the configuration and operations for handling upload.
15 Copyright 2018 the xRAN Forum.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
18 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 POSSIBILITY OF SUCH DAMAGE.
29 Redistribution and use in source and binary forms, with or without
30 modification, are permitted provided that the following conditions are met:
32 * Redistributions of source code must retain the above copyright notice,
33 this list of conditions and the above disclaimer.
34 * Redistributions in binary form must reproduce the above copyright notice,
35 this list of conditions and the above disclaimer in the documentation
36 and/or other materials provided with the distribution.
37 * Neither the Members of the xRAN Forum nor the names of its
38 contributors may be used to endorse or promote products derived from
39 this software without specific prior written permission.";
41 revision "2018-07-20" {
43 "version 1.0.0 - First release of the xRAN YANG M-Plane models.
45 This version of the model supports v01.00 of the corrsponding xRAN
46 M-Plane Specification.";
47 reference "XRAN-FH.MP.0-v01.00";
50 grouping file-path-grouping {
51 description "Complete logical path of the file on the RU to upload/download
52 (no wildcard is allowed) ex : /xRAN/log/syslog.1";
54 leaf local-logical-file-path {
57 description "Local logical file path";
60 leaf remote-file-path {
63 description "URI specifying the remote-file-path on lls-CU/NMS.
64 Format:sftp://user[:password]@host[:port]/path";
68 grouping output-status-grouping {
69 description "Status grouping";
78 description "Operation status";
82 when "../status = 'FAILURE'";
88 grouping credential-information{
89 description "Type of authentication to use for SFTP upload or download.";
98 "password needed for authentication.";
101 "password authentication method in use";
105 container certificate {
108 "certificate authentication method in use";
116 description "File upload over SFTP from RU to NETCONF client";
118 uses file-path-grouping;
119 uses credential-information;
122 uses output-status-grouping;
126 rpc retrieve-file-list {
127 description "List all the files in the logical xRAN unit (* is allowed as wild-card).";
132 description "xRAN unit of which the files are to be listed.
133 ex : xRAN/log, xRAN/PM, xRAN/transceiver";
135 leaf file-name-filter {
137 description "Filter which are to be applied on the result list of file names (* is allowed as wild-card).";
142 uses output-status-grouping;
143 leaf-list file-list {
144 when "../status = 'SUCCESS'";
146 description "List of files in the xRAN unit with the filter applied.";
151 notification file-upload-notification {
152 uses file-path-grouping;
153 uses output-status-grouping;
159 "Management plane triggered to generate the download file of RU.";
161 uses file-path-grouping;
162 uses credential-information;
165 uses output-status-grouping;
169 notification file-download-event {
170 uses file-path-grouping;
171 uses output-status-grouping;