VpnClients.idl

Go to the documentation of this file.

/**
 * @file     VpnClients.idl
 * @brief    API for VPN Clients page
 * @version  2
 */

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

module webadmin {

enum VpnClientState {
   VpnClientConnecting,
   VpnClientAuthenticating,
   VpnClientAuthenticated,
   VpnClientConnected,
   VpnClientOther
};

enum OsCodeType {
   OsWindows,
   OsLinux,
   OsMacos,
   OsUnknown
};

struct VpnClientInfo {
   kerio::web::KId       id;
   VpnType               type;
   string                userName;
   string                hostName;
   kerio::web::IpAddress ip;
   kerio::web::IpAddress clientIp;
   VpnClientState        state;
   long                  loginTime; /**< in seconds */
   string                version;
   OsCodeType            osCode;
   string                osName;
};

typedef sequence<VpnClientInfo> VpnClientList;

interface VpnClients {

   /**
    * Returns VPN Clients data
    *
    * @param list - output data
    * @param totalItems - all data count
    * @param query - filter/sort query
    * @param refresh - true in case, that data snapshot have to be refreshed
    * @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 get(out VpnClientList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh);


   /**
    * Disconnects clients specified in ids list
    *
    * @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 kill(in kerio::web::KIdList ids);

};

}; //webadmin