Assistant.idl

Go to the documentation of this file.

/**
 * @file     Assistant.idl
 * @brief    API for Assistants support
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <Interfaces.idl>

module webadmin {

struct WanInterfaceConfig {
   kerio::web::KId id;                 ///< not used on Box
   InterfaceEncapType encap;
   InterfaceModeType mode;
   kerio::web::IpAddress ip;
   kerio::web::IpAddress subnetMask;
   boolean gatewayAutodetected;
   kerio::web::IpAddress gateway;
   boolean dnsAutodetected;
   string dnsServers;                  ///< ipaddr;ipaddr
   kerio::web::OptionalLong loadBalancingWeight; ///< balancing
   CredentialsConfig credentials;      ///< for Pppoe mode
};

typedef sequence<WanInterfaceConfig> WanInterfaceConfigList;

struct LanInterfaceConfig {
   kerio::web::KId id;                 ///< not used on Box
   kerio::web::IpAddress ip;
   kerio::web::IpAddress subnetMask;
   boolean dhcpServerEnabled;
};

struct ConnectivityAssistantConfig {
   ConnectivityType type;              ///<  only Persistent, Failover, LoadBalancing
   WanInterfaceConfigList wans;
   LanInterfaceConfig lan;
   WifiConfig wifi;
};

interface ConnectivityAssistant {

   /**
    * Sets connectivity configuration from connectivity assistant
    * @param errors - list of errors \n
    *          1000  Operation failed. - "The connectivity type doesn't match the WAN interface count." \n
    *          1000  Operation failed. - "Unable to modify interface '%1'." \n
    *          1002  No such entity.   - "Unable to configure the interface."  
    * @param config - input configuration
    * @param revertTimeout - If client doesn't confirm config to this timeout, configuration is reverted (0 - revert disabled)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void set(out kerio::web::ErrorList errors, in ConnectivityAssistantConfig config, in long revertTimeout);
};

}; //webadmin