RouterAdvertisements.idl

Go to the documentation of this file.

/**
 * @file     RouterAdvertisements.idl
 * @brief    Router Advertisements API
 * @version  1
 */

#import <common.idl>
#import <Interfaces.idl>

module webadmin {

struct RouterAdvertisement {
  kerio::web::KId id;
  boolean enabled;
  IdReference interfaceId;
  Ip6AddressMask prefix;
};

typedef sequence<RouterAdvertisement> RouterAdvertisementList;

struct RouterAdvertisementsConfig {
   boolean enabled;
};

enum RouterAdvertisementsModeType {
   RouterAdvertisementsAutomatic,
   RouterAdvertisementsManual
};


interface RouterAdvertisements {

   /**
    * Returns list of Router Advertisement entries
    *     
    * @param list - list of entries
    * @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 RouterAdvertisementList list);

   /**
    * Stores Router Advertisement entries
    * 
    * Only 37 prefixes is allowed for one Interface, others will be ignored and error will be returned. Prefixes has to be unique for all interfaces.
    *
    * @param errors - list of errors \n
    *          1001  Already Exists.   - "Prefix '%1' is not unique." \n
    *          8001  Invalid params.   - "Prefix '%1' is not valid IPv6 address." \n
    *          8001  Invalid params.   - "Prefix '%1' doesn't match prefix length %2." \n
    *          8002  Database error.   - "Unable to modify Router Advertisement entry '%1'." \n
    *          8002  Database error.   - "Unable to create Router Advertisement entry '%1'." \n
    *          8002  Database error.   - "Unable to remove Router Advertisement entry '%1'." \n
    *          8005  Too many items.   - "Too many prefixes defined for interface '%1'."  
    * @param advertisements - list of advertisment configurations (prefixes) to be stored and advertised
    * @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 RouterAdvertisementList advertisements);

   /**
    * read Router Advertisements configuration
    * @param  config - configuration values
    * @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 getConfig(out RouterAdvertisementsConfig config);
   
   /**
    * stores Router Advertisements configuration
    * @param  config - configuration values
    * @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 setConfig(in RouterAdvertisementsConfig config);

   /**
    * read Router Advertisements mode
    * @param  mode - result       
    * @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 getMode(out RouterAdvertisementsModeType mode);
   
   /**
    * stores Router Advertisements mode
    * @param  mode - new value
    * @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 setMode(in RouterAdvertisementsModeType mode);

   
};

}; //webadmin