webadmin::Ports Interface Reference

Public Member Functions
void	get (out PortConfigList list)
void	set (out kerio::web::ErrorList errors, in PortConfigList ports, in long revertTimeout)

Member Function Documentation

void webadmin::Ports::get

(

out PortConfigList

list

)

Returns list of system ports together with assignments

Parameters

list	- list of ports sorted by port's order of precedence (WiFi last)

Exceptions

kerio::web::ApiException

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

Note

: System version has to support port and switch configuration

void webadmin::Ports::set	(	out kerio::web::ErrorList	errors,
		in PortConfigList	ports,
		in long	revertTimeout
	)

Stores configuration for system ports

If some of given items has id, that doesn't exist in current configuration, Error is returned
Unknown items are not added, no item is deleted

Parameters

errors	- list of errors 1000 Operation failed. - "Unable to modify port '%1'." 8000 Internal error. - "Internal error."
ports	- list of ports (order is not significant)
revertTimeout	- If client doesn't confirm config to this timeout, configuration is reverted (0 - revert disabled)

Exceptions

kerio::web::ApiException

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

Note

: System version has to support port and switch configuration

---

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

• Ports.idl