Public Member Functions | |
| void | exportConfig (out kerio::web::Download fileDownload, in ExportOptions options) |
| void | getImportInfo (out kerio::web::ErrorList errors, out boolean fullImportPossible, out boolean needIfaceMapping, out ImportedInterfaceList importedInterfaces, out CurrentInterfaceList currentInterfaces, in string fileId) |
| void | apply (out kerio::web::ErrorList errors, in ImportedInterfaceList interfaces, in string id, in boolean fullImport, in[Opt] boolean keepIdInFullImport) |
| void webadmin::Configuration::apply | ( | out kerio::web::ErrorList | errors, |
| in ImportedInterfaceList | interfaces, | ||
| in string | id, | ||
| in boolean | fullImport, | ||
| in boolean | keepIdInFullImport[Opt] | ||
| ) |
Applies changes obtained from imported configuration file and users interaction.
| errors | - list of errors 1000 Operation failed. - "Imported configuration cannot be loaded." 1000 Operation failed. - "Impotred configuration cannot be saved." |
| interfaces | - a list of interfaces from imported configuration with mappings to the currently present interfeces. This mapping should be ignored in fullimport. |
| id | - id of uploaded configuration file. (see spec. for uploader) |
| fullImport | - whether to do a full import (overvrite IP & domain setting with imported values) |
| keepIdInFullImport | - full import through kmanager will keep instanceId |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." 1000 Operation failed. - "Upload wasn't finished." |
| void webadmin::Configuration::exportConfig | ( | out kerio::web::Download | fileDownload, |
| in ExportOptions | options | ||
| ) |
Creates backup file and returns id.
| fileDownload | - description of the output file |
| options | - A set of options which configuration variables/list to store in exported file. |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." 1000 Operation failed. - "Unable to create temporary directory." 1000 Operation failed. - "Error during tar archive creation." |
| void webadmin::Configuration::getImportInfo | ( | out kerio::web::ErrorList | errors, |
| out boolean | fullImportPossible, | ||
| out boolean | needIfaceMapping, | ||
| out ImportedInterfaceList | importedInterfaces, | ||
| out CurrentInterfaceList | currentInterfaces, | ||
| in string | fileId | ||
| ) |
Returns additiaonal information about imported configuration needed during it's import.
| errors | - list of errors 1000 Operation failed. - "Extraction has already started." 1000 Operation failed. - "Unable to create temporary directory." 1000 Operation failed. - "Unable to process imported file." 1000 Operation failed. - "Unable to import configuration from a version older than %1." 1000 Operation failed. - "Unable to import configuration, the version in the configuration file is higher than the version needed." |
| fullImportPossible | - tells whether it is possible to import configuration 1:1 (with IP settings). |
| needIfaceMapping | - tells whether it has to be setup iface mapping in case of fullImportPossible |
| importedInterfaces | - a list of interfaces loaded from the imported configuration file. |
| currentInterfaces | - a list of interfaces available in currently loaded configuration. |
| fileId | - id of uploaded configuration file. (see spec. for uploader) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." 8000 Internal error. - "Internal error." |
