Inspectors.idl

Go to the documentation of this file.

/**
 * @file     Inspectors.idl
 * @brief    API for protocol inspectors administration
 * @version  2
 */

module webadmin {

/**
 * Protocol Inspector - instances defined at compilation time, unchangeable
 */
struct Inspector {
   string             name;                ///< unique name for the inspector
   long               ipProtocol;          ///< IP protocol (only 6 for TCP or 17 for UDP)
};

typedef sequence<Inspector> InspectorList;

interface Inspectors {

   /**
    * Returns available Protocol Inspectors
    * @param list - list of inspectors and it's details
    * @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 InspectorList list);

};

}; //webadmin