webadmin::BandwidthManagement Interface Reference

Public Member Functions
void	get (out BandwidthManagementConfig config)
void	set (out kerio::web::ErrorList errors, in BandwidthManagementConfig config)
void	getBandwidth (out InternetBandwidthList list)
void	setBandwidth (out kerio::web::ErrorList errors, in InternetBandwidthList list)

Member Function Documentation

void webadmin::BandwidthManagement::get

(

out BandwidthManagementConfig

config

)

Get the list of Bandwidth Management rules

Parameters

config

- Bandwidth Management rules

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::BandwidthManagement::getBandwidth

(

out InternetBandwidthList

list

)

Returns list of Internet interfaces and their current usage

Parameters

list	- list of interfaces (sorted by name); empty if there are no Internet interfaces

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::BandwidthManagement::set	(	out kerio::web::ErrorList	errors,
		in BandwidthManagementConfig	config
	)

Stores the list of Bandwidth Management rules

Parameters

errors	- list of errors 8002 Database error. - "Unable to modify rule '%1'." 8002 Database error. - "Unable to create rule '%1'." 8002 Database error. - "Unable to delete rule '%1'."
config	- Bandwidth Management rules

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::BandwidthManagement::setBandwidth	(	out kerio::web::ErrorList	errors,
		in InternetBandwidthList	list
	)

Stores the list of Bandwidth Management rules Note: from the InternetBandwidth structure only values id, download/upload speed and unit are used

Parameters

errors	- list of errors 8002 Database error. - "Unable to set bandwidth properties for interface %1."
list	- list of Bandwidth Management rules

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

---

The documentation for this interface was generated from the following file:

• BandwidthManagement.idl