webadmin::Dns Interface Reference

Public Member Functions
void	get (out DnsConfig config)
void	getHosts (out DnsHostList hosts)
void	set (out kerio::web::ErrorList errors, in DnsConfig config)
void	setHosts (out kerio::web::ErrorList errors, in DnsHostList hosts)
void	importHosts (in string fileId, in boolean clean)
void	clearCache ()

Member Function Documentation

void webadmin::Dns::clearCache

(

)

Flushes DNS cache

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::Dns::get

(

out DnsConfig

config

)

Returns DNS configuration

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::Dns::getHosts

(

out DnsHostList

hosts

)

Returns DNS ip/hosts mapping

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::Dns::importHosts	(	in string	fileId,
		in boolean	clean
	)

Imports DNS hosts records from file (hosts format)

Parameters

fileId	- id of uploaded file
clean	- true, if current hosts records should be removed, false, if new records should be appended to current config

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1002 No such entity. - "Unable to open the uploaded file." 1004 Access denied. - "Insufficient rights to perform the requested operation." 8000 Internal error. - "Internal error."

void webadmin::Dns::set	(	out kerio::web::ErrorList	errors,
		in DnsConfig	config
	)

Stores DNS configuration

Parameters

errors	- list of errors 8002 Database error. - "Unable to modify custom DNS forwarding entry '%1'." 8002 Database error. - "Unable to create custom DNS forwarding entry '%1'." 8002 Database error. - "Unable to remove custom DNS forwarding entry '%1'."
config	- A structure containing all the settings of DND that sould be stored.

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::Dns::setHosts	(	out kerio::web::ErrorList	errors,
		in DnsHostList	hosts
	)

Stores DNS ip/hosts mapping

Parameters

errors	- list of errors 8002 Database error. - "Unable to modify DNS host entry '%1'." 8002 Database error. - "Unable to create DNS host entry '%1'." 8002 Database error. - "Unable to remove DNS host entry '%1'."
hosts	- list of hosts file entries to be stored

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:

• Dns.idl