All Classes Files Functions Variables Pages
ConfigurationBackup.idl
Go to the documentation of this file.
1 /**
2  * @file ConfigurationBackup.idl
3  * @brief Configuration backup API
4  * @version 2
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 #import <common.idl>
9 
10 module webadmin {
11 
12 enum Target {
13  TargetFtpServer,
14  TargetMyKerio
15 };
16 
18  boolean enabled;
19  Target target;
20  string username;
21  string password;
22  string url;
23 };
24 
25 enum ConfigurationBackupPhase {
26  ConfigurationBackupOk,
27  ConfigurationBackupInProgress,
28  ConfigurationBackupFailed
29 };
30 
32  ConfigurationBackupPhase phase;
33  TimeSpan lastBackup; /**< how long is since last backup */
34  string url;
35  string errorMessage;
36 };
37 
39 
40  /**
41  * Returns configuration
42  * @param config - Contains Structure with Configuration backup settings.
43  * @throws kerio::web::ApiException \n
44  * -32001 Session expired. - "The user is not logged in." \n
45  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
46  */
47  void get(out ConfigurationBackupConfig config);
48 
49  /**
50  * Stores configuration
51  * @param config - Contains Structure with Configuration backup settings.
52  * @throws kerio::web::ApiException \n
53  * -32001 Session expired. - "The user is not logged in." \n
54  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
55  */
56  void set(in ConfigurationBackupConfig config);
57 
58  /**
59  * Runs backup
60  * @throws kerio::web::ApiException \n
61  * -32001 Session expired. - "The user is not logged in." \n
62  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
63  */
64  void backupNow();
65 
66  /**
67  * Returns actual state of Configuration backup status
68  * @param status - a phase of update process.
69  * @throws kerio::web::ApiException \n
70  * -32001 Session expired. - "The user is not logged in." \n
71  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
72  */
73  void getStatus(out ConfigurationBackupStatus status);
74 
75 
76 };
77 
78 }; //webadmin
79 
Definition: ConfigurationBackup.idl:38
Definition: ConfigurationBackup.idl:17
Common Kerio Control structures, enums and types.
Definition: common.idl:67
TimeSpan lastBackup
Definition: ConfigurationBackup.idl:33
Definition: Accounting.idl:11
Definition: ConfigurationBackup.idl:31