Administration API for Kerio Control: Main Page

All Classes Files Functions Variables Pages

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

void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in DhcpScopeList scopes)

void	set (out kerio::web::ErrorList errors, in kerio::web::StringList scopeIds, in DhcpScope details)

void	remove (out kerio::web::ErrorList errors, in kerio::web::StringList scopeIds)

void	getInterfaceTemplate (out DhcpScope details, in kerio::web::KId ifaceId)

void	getLeases (out DhcpLeaseList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KIdList scopeIds)

void	createLeases (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in DhcpLeaseList leases)

void	setLeases (out kerio::web::ErrorList errors, in kerio::web::StringList leaseIds, in DhcpLease details)

void	removeLeases (out kerio::web::ErrorList errors, in kerio::web::StringList leaseIds)

void	getMode (out DhcpMode mode)

void	setMode (in DhcpMode mode)

void	getConfig (out DhcpConfig config)

void	setConfig (in DhcpConfig config)

void	getOptionList (out DhcpOptionList options)

void	getDeclinedLeases (out long count, in kerio::web::KIdList scopeIds)

void	removeDeclinedLeases (in kerio::web::KIdList scopeIds)

void	apply (out kerio::web::ErrorList errors)

void	reset ()

Member Function Documentation

void webadmin::Dhcp::apply ( out kerio::web::ErrorList errors )

write changes cached in manager to configuration

Parameters

errors - list of errors
8001 Invalid params. - "Unable to add/modify DHCP reservation %1, wrong parameters."
8001 Invalid params. - "Unable to add/modify DHCP scope %1. Wrong address scope or mask."
8002 Database error. - "Unable to add/modify DHCP reservation %1."
8002 Database error. - "Unable to delete the DHCP reservation."
8002 Database error. - "Unable to add/modify DHCP scope %1."
8002 Database error. - "Unable to delete the DHCP scope."

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::Dhcp::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in DhcpScopeList	scopes
	)

add new scope

Parameters

errors	- list of errors 1001 Already exists. - "Unable to add/modify DHCP scope %1. Scope is a subnet of another scope." 1001 Already exists. - "Unable to add/modify DHCP scope %1. Another scope is a subnet of this scope." 1001 Already exists. - "Unable to add/modify DHCP scope %1. Scope on the same subnet is already defined." 8001 Invalid params. - "Unable to add/modify DHCP scope %1. First address and Last address are from different networks."
result	- list of IDs assigned to each item
scopes	- details for new scopes. field id is assigned by the manager to temporary value until apply() or reset().

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::Dhcp::createLeases	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in DhcpLeaseList	leases
	)

add new reservation

Parameters

errors	- list of errors 1001 Already exists. - "DHCP reservation for %1 already exists."
result	- list of IDs assigned to each item
leases	- details for new reservations. field id is assigned by the manager to temporary value until apply() or reset().

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::Dhcp::get	(	out DhcpScopeList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

** SCOPES PART ** get the list of scopes

Parameters

list	- list of scopes and it's details
totalItems	- count of all scopes on server (before the start/limit applied)
query	- conditions and limits

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::Dhcp::getConfig ( out DhcpConfig config )

read Dhcp configuration (not part of persistent manager, returns actual state)

Parameters

config - configuration 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::Dhcp::getDeclinedLeases	(	out long	count,
		in kerio::web::KIdList	scopeIds
	)

Returns count of declined leases in all scopes, defined by scopeIDs param

Parameters

count	- count of declined leases
scopeIds	- list of scope IDs or empty for all scopes

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::Dhcp::getInterfaceTemplate	(	out DhcpScope	details,
		in kerio::web::KId	ifaceId
	)

get generated scope information for interface

Parameters

details	- configuration for given ifaceId - can be passed to create method
ifaceId	- id of interface, for which the template will be created

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::Dhcp::getLeases	(	out DhcpLeaseList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KIdList	scopeIds
	)

** LEASE & RESERVATION PART ** get the list of leases

Parameters

list	- list of leases/reservations and it's details
totalItems	- count of all leases/reservations on server (before the start/limit applied)
query	- conditions and limits
scopeIds	- list of scope Ids, where leases should be included (empty for all scopes)

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::Dhcp::getMode ( out DhcpMode mode )

** COMMON PART ** read Dhcp mode (not part of persistent manager, returns actual state)

Parameters

mode - result

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::Dhcp::getOptionList ( out DhcpOptionList options )

get list of all options

Parameters

options - list of all options

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::Dhcp::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	scopeIds
	)

remove scope

Parameters

errors	- list of errors
scopeIds	- ids of scopes that should be removed

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::Dhcp::removeDeclinedLeases ( in kerio::web::KIdList scopeIds )

Removes declined leases defined by scopeIDs param from engine

Parameters

scopeIds - list of scope IDs or empty for all scopes

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::Dhcp::removeLeases	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	leaseIds
	)

remove leases

Parameters

errors	- list of errors
leaseIds	- ids of leases/reservations that should be removed

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::Dhcp::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::Dhcp::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	scopeIds,
		in DhcpScope	details
	)

update existing scope

Parameters

errors	- list of errors 1001 Already exists. - "Unable to add/modify DHCP scope %1. Scope is a subnet of another scope." 1001 Already exists. - "Unable to add/modify DHCP scope %1. Another scope is a subnet of this scope." 1001 Already exists. - "Unable to add/modify DHCP scope %1. Scope on the same subnet is already defined." 8001 Invalid params. - "Unable to add/modify DHCP scope %1. First address and Last address are from different networks."
scopeIds	- ids of scopes to be updated.
details	- details for update. Field "kerio::web::KId" is ignored. All other fields must be filled and they are written to all scopes specified by scopeIds.

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::Dhcp::setConfig ( in DhcpConfig config )

stores Dhcp configuration (not part of persistent manager, changes settings immediately)

Parameters

config - configuration 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::Dhcp::setLeases	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	leaseIds,
		in DhcpLease	details
	)

update existing leases

Parameters

errors	- list of errors 1001 Already exists. - "DHCP reservation for %1 already exists."
leaseIds	- ids of reservations to be updated.
details	- details for update. Field "kerio::web::KId" is ignored. All other fields must be filled and they are written to all scopes specified by scopeIds.

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::Dhcp::setMode ( in DhcpMode mode )

stores Dhcp mode (not part of persistent manager, changes mode immediately)

Parameters

mode	- new value

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:

Dhcp.idl

© Kerio Technologies s.r.o., all rights reserved.