1 module org-openroadm-file-transfer {
2 namespace "http://org/openroadm/file-transfer";
3 prefix org-openroadm-file-txr;
5 import ietf-inet-types {
9 import org-openroadm-common-types {
10 prefix org-openroadm-common-types;
13 organization "Open ROADM MSA";
17 "YANG definitions for file management related rpcs.
19 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
20 AT&T Intellectual Property. All other rights reserved.
22 Redistribution and use in source and binary forms, with or without modification,
23 are permitted provided that the following conditions are met:
25 * Redistributions of source code must retain the above copyright notice, this
26 list of conditions and the following disclaimer.
27 * Redistributions in binary form must reproduce the above copyright notice,
28 this list of conditions and the following disclaimer in the documentation and/or
29 other materials provided with the distribution.
30 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
31 contributors may be used to endorse or promote products derived from this software
32 without specific prior written permission.
34 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
35 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
36 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
37 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
38 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
40 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
41 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43 POSSIBILITY OF SUCH DAMAGE.";
52 "File transfer using FTP/SFTP";
57 "Type of action - download/upload.";
61 "Specify the upload action. The server sends
62 the file identified by the local-file-path
63 to the remote-file-path.";
67 "Specify the download action. The server retrieves
68 the file identified by the remote-file-path
69 to the local-file-path.";
73 leaf local-file-path {
78 Ex: /var/shared/example.txt";
80 leaf remote-file-path {
85 A URI for the remote file path.
87 Format:sftp://user[:password]@host[:port]/path.
88 Ex: sftp://test:verify@[2001:db8:0:1::10]:22/home/user/sample";
92 uses org-openroadm-common-types:rpc-response-status;
97 "Show one or more files in the specified directory.";
104 "Specify file(s) to be listed (* is allowed as wild-card). ";
119 "Successful or Failed";
121 leaf-list status-message {
124 "Gives a more detailed reason for success / failure";
130 "Delete one or more files in the specified directory.";
138 "Specify file(s) to be deleted (* is allowed as wild-card).";
142 uses org-openroadm-common-types:rpc-response-status;