webadmin::RouterAdvertisements Interface Reference

Public Member Functions
void	get (out RouterAdvertisementList list)
void	set (out kerio::web::ErrorList errors, in RouterAdvertisementList advertisements)
void	getConfig (out RouterAdvertisementsConfig config)
void	setConfig (in RouterAdvertisementsConfig config)
void	getMode (out RouterAdvertisementsModeType mode)
void	setMode (in RouterAdvertisementsModeType mode)

Member Function Documentation

void webadmin::RouterAdvertisements::get

(

out RouterAdvertisementList

list

)

Returns list of Router Advertisement entries

Parameters

list	- list of entries

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::RouterAdvertisements::getConfig

(

out RouterAdvertisementsConfig

config

)

read Router Advertisements configuration

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::RouterAdvertisements::getMode

(

out RouterAdvertisementsModeType

mode

)

read Router Advertisements mode

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::RouterAdvertisements::set	(	out kerio::web::ErrorList	errors,
		in RouterAdvertisementList	advertisements
	)

Stores Router Advertisement entries

Only 37 prefixes is allowed for one Interface, others will be ignored and error will be returned. Prefixes has to be unique for all interfaces.

Parameters

errors

- list of errors 1001 Already Exists. - "Prefix '%1' is not unique." 8001 Invalid params. - "Prefix '%1' is not valid IPv6 address." 8001 Invalid params. - "Prefix '%1' doesn't match prefix length %2." 8002 Database error. - "Unable to modify Router Advertisement entry '%1'." 8002 Database error. - "Unable to create Router Advertisement entry '%1'." 8002 Database error. - "Unable to remove Router Advertisement entry '%1'." 8005 Too many items. - "Too many prefixes defined for interface '%1'."

advertisements

- list of advertisment configurations (prefixes) to be stored and advertised

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::RouterAdvertisements::setConfig

(

in RouterAdvertisementsConfig

config

)

stores Router Advertisements configuration

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::RouterAdvertisements::setMode

(

in RouterAdvertisementsModeType

mode

)

stores Router Advertisements mode

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:

• RouterAdvertisements.idl