Public Member Functions | |
| void | get (out ActiveHostList list, out long totalItems, in kerio::web::SearchQuery query, in boolean refresh) |
| void | getActivityList (out ActivityList list, in kerio::web::KId id) |
| void | getHistogram (out Histogram hist, in kerio::web::HistogramType type, in kerio::web::KId id) |
| void | getHistogramInc (out Histogram hist, out kerio::web::DateTimeStamp sampleTime, in kerio::web::HistogramIntervalType type, in kerio::web::KId id, in kerio::web::DateTimeStamp startSampleTime) |
| void | logout (in kerio::web::KIdList ids) |
| void | login (in kerio::web::KId hostId, in string userName) |
| void webadmin::ActiveHosts::get | ( | out ActiveHostList | list, |
| out long | totalItems, | ||
| in kerio::web::SearchQuery | query, | ||
| in boolean | refresh | ||
| ) |
Returns Active Hosts data
| list | - output data |
| totalItems | - all data count |
| query | - filter/sort query |
| refresh | - true in case, that data snapshot have to be refreshed |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::ActiveHosts::getActivityList | ( | out ActivityList | list, |
| in kerio::web::KId | id | ||
| ) |
Returns Activities for specified host
| list | - output data |
| id | - Active Host id returned by get |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1002 No such entity. - "Invalid host id." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::ActiveHosts::getHistogram | ( | out Histogram | hist, |
| in kerio::web::HistogramType | type, | ||
| in kerio::web::KId | id | ||
| ) |
Returns throughput Histogram for specified host
| hist | - samples of traffic rate for given host |
| type | - granularity (two hours or one day) |
| id | - Active Host id returned by get |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1002 No such entity. - "Invalid host id." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::ActiveHosts::getHistogramInc | ( | out Histogram | hist, |
| out kerio::web::DateTimeStamp | sampleTime, | ||
| in kerio::web::HistogramIntervalType | type, | ||
| in kerio::web::KId | id, | ||
| in kerio::web::DateTimeStamp | startSampleTime | ||
| ) |
Returns throughput Histogram for specified host
| hist | - output data |
| sampleTime | - Returns first time, that is not included in returned data (pass it to the same method again as a lastSampleTime to obtain only new data since last request) |
| startSampleTime | - Specifies starting time for returned data |
| type | - granularity |
| id | - rule or interface id returned in item.id member by get |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::ActiveHosts::login | ( | in kerio::web::KId | hostId, |
| in string | userName | ||
| ) |
Logs in user for specified host
| hostId | - internal identifier of a host computer in network |
| userName | - Name of a user to be loged from given host specified by hostId (including domain if needed) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1000 Operation failed. - "Some user is already logged in from specified host." 1002 No such entity. - "Invalid host id." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::ActiveHosts::logout | ( | in kerio::web::KIdList | ids | ) |
Logout users from specified hosts / empty for all hosts
| ids | - Active Host ids returned by get or empty for logout all hosts |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
