All Classes Files Functions Variables Pages
Assistant.idl
Go to the documentation of this file.
1 /**
2  * @file Assistant.idl
3  * @brief API for Assistants support
4  * @version 2
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 #import <Interfaces.idl>
9 
10 module webadmin {
11 
13  kerio::web::KId id; ///< not used on Box
14  InterfaceEncapType encap;
15  InterfaceModeType mode;
16  kerio::web::IpAddress ip;
17  kerio::web::IpAddress subnetMask;
18  boolean gatewayAutodetected;
19  kerio::web::IpAddress gateway;
20  boolean dnsAutodetected;
21  string dnsServers; ///< ipaddr;ipaddr
23  CredentialsConfig credentials; ///< for Pppoe mode
24 };
25 
26 typedef sequence<WanInterfaceConfig> WanInterfaceConfigList;
27 
29  kerio::web::KId id; ///< not used on Box
30  kerio::web::IpAddress ip;
31  kerio::web::IpAddress subnetMask;
32  boolean dhcpServerEnabled;
33 };
34 
36  ConnectivityType type; ///< only Persistent, Failover, LoadBalancing
37  WanInterfaceConfigList wans;
39 };
40 
42 
43  /**
44  * Sets connectivity configuration from connectivity assistant
45  * @param errors - list of errors \n
46  * 1000 Operation failed. - "The connectivity type doesn't match the WAN interface count." \n
47  * 1000 Operation failed. - "Unable to modify interface '%1'." \n
48  * 1002 No such entity. - "Unable to configure the interface."
49  * @param config - input configuration
50  * @param revertTimeout - If client doesn't confirm config to this timeout, configuration is reverted (0 - revert disabled)
51  * @throws kerio::web::ApiException \n
52  * -32001 Session expired. - "The user is not logged in." \n
53  * 1004 Access denied. - "Insufficient rights to perform the requested operation."
54  */
55  void set(out kerio::web::ErrorList errors, in ConnectivityAssistantConfig config, in long revertTimeout);
56 };
57 
58 }; //webadmin
kerio::web::OptionalLong loadBalancingWeight
balancing
Definition: Assistant.idl:22
ConnectivityType type
only Persistent, Failover, LoadBalancing
Definition: Assistant.idl:36
Definition: Assistant.idl:12
Definition: SharedStructures.idl:298
string dnsServers
ipaddr;ipaddr
Definition: Assistant.idl:21
CredentialsConfig credentials
for Pppoe mode
Definition: Assistant.idl:23
Definition: common.idl:18
kerio::web::KId id
not used on Box
Definition: Assistant.idl:29
kerio::web::KId id
not used on Box
Definition: Assistant.idl:13
API for network interfaces administration.
Definition: Assistant.idl:41
Definition: Assistant.idl:35
Definition: Accounting.idl:11
Definition: Assistant.idl:28