1 module o-ran-file-management {
3 namespace "urn:o-ran:file-management:1.0";
4 prefix "o-ran-file-mgmt";
6 import ietf-crypto-types {
11 organization "O-RAN Alliance";
17 "This module defines the configuration and operations for handling upload.
19 Copyright 2019 the O-RAN Alliance.
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 POSSIBILITY OF SUCH DAMAGE.
33 Redistribution and use in source and binary forms, with or without
34 modification, are permitted provided that the following conditions are met:
36 * Redistributions of source code must retain the above copyright notice,
37 this list of conditions and the above disclaimer.
38 * Redistributions in binary form must reproduce the above copyright notice,
39 this list of conditions and the above disclaimer in the documentation
40 and/or other materials provided with the distribution.
41 * Neither the Members of the O-RAN Alliance nor the names of its
42 contributors may be used to endorse or promote products derived from
43 this software without specific prior written permission.";
45 revision "2019-07-03" {
49 1) backward compatible changes to correct sFTP Server Authentication .
50 2) minor fixes according to lack of descriptions
51 3) backward compatible changes to introduce groupings";
53 reference "ORAN-WG4.M.0-v01.00";
56 revision "2019-02-04" {
60 1) imported model from xRAN
61 2) changed namespace and reference from xran to o-ran";
63 reference "ORAN-WG4.M.0-v01.00";
66 grouping file-path-grouping {
67 description "Complete logical path of the file to upload/download
68 (no wildcard is allowed) ex : /o-RAN/log/syslog.1";
70 leaf local-logical-file-path {
73 description "Local logical file path";
76 leaf remote-file-path {
79 description "URI specifying the remote-file-path on O-DU/NMS.
80 Format:sftp://<username>@<host>[:port]/path";
84 grouping output-status-grouping {
85 description "Status grouping";
94 description "Operation status";
98 when "../status = 'FAILURE'";
104 grouping credential-information {
105 description "Type of authentication to use for SFTP upload or download.";
114 "password needed for O-RU authentication.";
117 "password for O-RU authentication method in use";
123 uses ct:public-key-grouping;
125 "List of allowed algorithms with its keys";
128 "Key for sFTP server authentication";
132 container certificate {
135 "certificate authentication method in use";
142 grouping retrieve-input {
143 description "Grouping for information retrieval RPC input";
147 description "O-RAN unit of which the files are to be listed.
148 ex : O-RAN/log, o-RAN/PM, O-RAN/transceiver";
150 leaf file-name-filter {
152 description "Filter which are to be applied on the result list of file names (* is allowed as wild-card).";
156 grouping retrieve-output {
157 description "Grouping for information retrieval RPC output";
158 uses output-status-grouping;
159 leaf-list file-list {
160 when "../status = 'SUCCESS'";
162 description "List of files in the unit with the filter applied.";
169 description "File upload over SFTP from equipment to NETCONF client";
171 uses file-path-grouping;
172 uses credential-information;
175 uses output-status-grouping;
179 rpc retrieve-file-list {
180 description "List all the files in the logical O-RAN unit (* is allowed as wild-card).";
186 uses retrieve-output;
190 notification file-upload-notification {
191 uses file-path-grouping;
192 uses output-status-grouping;
198 "Management plane triggered to generate the download file of O-RU.";
200 uses file-path-grouping;
201 uses credential-information;
204 uses output-status-grouping;
208 notification file-download-event {
209 uses file-path-grouping;
210 uses output-status-grouping;