All Classes Files Functions Variables Pages
IpTools.idl
Go to the documentation of this file.
1 /**
2  * @file IpTools.idl
3  * @brief IP Tools API
4  * @version 1
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 
9 module webadmin {
10 
11 enum ActiveTool {
12  ActiveToolNone,
13  ActiveToolPing,
14  ActiveToolTraceRoute,
15  ActiveToolDns,
16  ActiveToolWhois
17 };
18 
19 enum DnsTool {
20  DnsToolNslookup,
21  DnsToolDig
22 };
23 
24 enum DnsType {
25  DnsTypeAny,
26  DnsTypeA,
27  DnsTypeAAAA,
28  DnsTypeCname,
29  DnsTypeMx,
30  DnsTypeNs,
31  DnsTypePtr,
32  DnsTypeSoa,
33  DnsTypeSpf,
34  DnsTypeSrv,
35  DnsTypeTxt
36 };
37 
38 enum IpVersion {
39  IpVersion4,
40  IpVersion6,
41  IpVersionAny
42 };
43 
44 interface IpTools {
45 
46  /**
47  * @throws kerio::web::ApiException \n
48  * -32001 Session expired. - "The user is not logged in." \n
49  * 1004 Access denied - "Insufficient rights to perform the requested operation."
50  */
51  void getStatus(out ActiveTool activeTool, out kerio::web::StringList lines);
52 
53  /**
54  * Interrupt currently running tool
55  *
56  * @throws kerio::web::ApiException \n
57  * -32001 Session expired. - "The user is not logged in." \n
58  * 1004 Access denied - "Insufficient rights to perform the requested operation."
59  */
60  void stop();
61 
62  /**
63  * @throws kerio::web::ApiException \n
64  * -32001 Session expired. - "The user is not logged in." \n
65  * 1004 Access denied - "Insufficient rights to perform the requested operation."
66  */
67  void ping(in string target, in IpVersion ipv, in boolean infinite, in long packetSize, in boolean allowFragmentation);
68 
69  /**
70  * @throws kerio::web::ApiException \n
71  * -32001 Session expired. - "The user is not logged in." \n
72  * 1004 Access denied - "Insufficient rights to perform the requested operation."
73  */
74  void traceRoute(in string target, in IpVersion ipv, in boolean resolveHostnames);
75 
76  void whois(in string target);
77 
78  void dns(in string name, in string server, in DnsTool tool, in DnsType type);
79 
80  void getDnsServers(out kerio::web::StringList servers);
81 };
82 
83 };//webadmin
84 
Definition: IpTools.idl:44
Definition: Accounting.idl:11