All Classes Files Functions Variables Pages
SystemTasks.idl
Go to the documentation of this file.
1 /**
2  * @file SystemTasks.idl
3  * @brief API for System tasks on Linux
4  * @version 1
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 
9 module webadmin {
10 
11 interface SystemTasks {
12  /**
13  * Returns SSH status
14  * @param running - SSH is running
15  * @throws kerio::web::ApiException \n
16  * -32001 Session expired. - "The user is not logged in." \n
17  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
18  */
19  void getSsh(out boolean running);
20 
21  /**
22  * Sets SSH setting
23  * @param enable - true - enable SSH, false - disable SSH
24  * @throws kerio::web::ApiException \n
25  * -32001 Session expired. - "The user is not logged in." \n
26  * 1000 Operation failed. - "Unable to change SSH status." \n
27  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
28  */
29  void setSsh(in boolean enable);
30 
31  /**
32  * Performs system reboot
33  * @throws kerio::web::ApiException \n
34  * -32001 Session expired. - "The user is not logged in." \n
35  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
36  */
37  void reboot();
38 
39  /**
40  * Performs system shutdown
41  * @throws kerio::web::ApiException \n
42  * -32001 Session expired. - "The user is not logged in." \n
43  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
44  */
45  void shutdown();
46 };
47 
48 }; //webadmin
webadmin::SystemTasks
Definition: SystemTasks.idl:11
webadmin
Definition: Accounting.idl:11