Snmp.idl

Go to the documentation of this file.

/**
 * @file     Snmp.idl
 * @brief    SNMP API
 * @version  1
 */

#import <common.idl>

module webadmin {

enum SnmpVersion {
   SnmpV2c,
   SnmpV3
};

struct SnmpSettings {
   boolean enabled;
   string location;
   string contact;
   SnmpVersion version;
   Password community;
   string username;
   Password password;
};

interface Snmp {
   
   /**
    * Returns SNMP configuration
    * @param settings - A structure containing all the settings of SNMP that are stored.
    * @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 SnmpSettings settings);

   /**
    * Stores SNMP configuration
    * @param settings - A structure containing all the settings of SNMP that sould be stored.
    * @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(in SnmpSettings settings);
};

};