Public Member Functions
void	get (out InterfaceList list, out long totalItems, in kerio::web::SearchQuery query, in boolean sortByGroup)

void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in InterfaceList list)

void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList ids, in Interface details)

void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)

void	checkIpCollision (out IpCollisionList collisions)

void	getWarnings (out NotificationTypeList warnings)

void	getConnectivityConfig (out ConnectivityConfig config)

void	setConnectivityConfig (in ConnectivityConfig config)

void	startConnectivityTest ()

void	connectivityTestStatus (out ConnectivityStatus status)

void	cancelConnectivityTest ()

void	dial (in kerio::web::KId id)

void	hangup (in kerio::web::KId id)

void	getIpsecPeerIdConfig (out IpsecPeerIdConfig config)

void	apply (out kerio::web::ErrorList errors, in long revertTimeout)

void	reset ()

Member Function Documentation

void webadmin::Interfaces::apply	(	out kerio::web::ErrorList	errors,
		in long	revertTimeout
	)

write changes cached in manager to configuration

Parameters

errors - list of errors
1001 Already exists. - "The same IP address is assigned to several interfaces."
1001 Already exists. - "The VPN server address range collides with interface %1."
1001 Already exists. - "Interface %1 already exists."
8001 Invalid params. - "Just one interface must be set for primary connection."
8001 Invalid params. - "Just one interface must be set for secondary connection."
8001 Invalid params. - "Just one interface is allowed to be set for dial on demand."
8001 Invalid params. - "Unable to add/modify tunnel %1, wrong parameters."
8002 Database error. - "Unable to add/modify tunnel %1."
8002 Database error. - "Unable to delete the tunnel."

revertTimeout how many seconds to wait for confirmation until revert is performed

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::Interfaces::cancelConnectivityTest ( )

Cancels testing of connectivity nad sets status to ConnectivityError

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::Interfaces::checkIpCollision ( out IpCollisionList collisions )

Checks collision of all interfaces IP + VPN Server network

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::Interfaces::connectivityTestStatus ( out ConnectivityStatus status )

Returns progress of connectivity test

startTest() has to be called before call of this function, otherwise status is instantly ConnectivityError.

Parameters

status - actual status

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::Interfaces::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in InterfaceList	list
	)

Creates new interface (Only one interface can be created at a time) - VPN Tunnel or RAS on Ape/Box

Parameters

errors	- list of errors 1001 Already exists. - "A tunnel with fingerprint %1 already exists!" 1001 Already exists. - "Tunnel %1 already exists!" 1001 Already exists. - "Interface %1 already exists."
result	- list of IDs assigned to each item
list	- list of interfaces desired to be created (must contain exactly one item)

Exceptions

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."

void webadmin::Interfaces::dial ( in kerio::web::KId id )

Dial interface. Works only for disconnected RAS. Action is taken immediatelly, without apply.

Exceptions

kerio::web::ApiException -32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Unable to dial interface."
1004 Access denied. - "You have no rights to dial this line."

void webadmin::Interfaces::get	(	out InterfaceList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in boolean	sortByGroup
	)

Obtain list of interfaces

Exceptions

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

Note: : when sorting is set to 'name' column, interfaces are first sorted by 'type' and then by 'name'.
When sortByGroup is true and sorting is 'name', sorting order is 'group', 'type', 'name'

void webadmin::Interfaces::getConnectivityConfig ( out ConnectivityConfig config )

Returns Connectivity config values

Parameters

config - Connectivity config values

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::Interfaces::getIpsecPeerIdConfig ( out IpsecPeerIdConfig config )

Returns (defaults/read-only) values to be displayed on VPN Tunnel IPsec dialog as peer ID config

Exceptions

kerio::web::ApiException -32001 Session expired. - "The user is not logged in."
1004 Access denied. - "You have no rights to hang-up this line."

void webadmin::Interfaces::getWarnings ( out NotificationTypeList warnings )

Checks Link Load Balancing warnings

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::Interfaces::hangup ( in kerio::web::KId id )

Hangup interface. Works only for connected RAS. Action is taken immediatelly, without apply.

Exceptions

kerio::web::ApiException -32001 Session expired. - "The user is not logged in."
1000 Operation failed. - "Unable to hang-up interface."
1004 Access denied. - "You have no rights to hang-up this line."

void webadmin::Interfaces::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Delete Interface configuration - VPN Tunnel or RAS on Ape/Box

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::Interfaces::reset ( )

discard changes cached in manager

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::Interfaces::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids,
		in Interface	details
	)

Update interface's details

Parameters

errors	- list of errors 1001 Already exists. - "A tunnel with fingerprint %1 already exists!" 1001 Already exists. - "Tunnel %1 already exists!"
ids	- list of IDs of interfaces to modify
details	- details to set to every interface lister in ids parameter

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::Interfaces::setConnectivityConfig ( in ConnectivityConfig config )

Stores Connectivity config values

Parameters

config - Connectivity config values

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::Interfaces::startConnectivityTest ( )

Initiates testing of connectivity

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:

Interfaces.idl

Administration API for Kerio Control

Public Member Functions

Member Function Documentation