All Classes Files Functions Variables Enumerations Enumerator Groups Pages
kerio::jsonapi::admin::DistributedDomain Interface Reference

Public Member Functions

void connect (out ClusterError result, in string hostName, in string adminUser, in string password)
void copy (in string domainName)
void disconnect ()
void getDistributable (out kerio::web::StringList domainNames, in ClusterAuthentication authentication, in boolean connected)
void getRole (out ClusterRole role, out boolean isMultiServer)
void getServerList (out ClusterServerList servers)
void getHomeServerList (out HomeServerList servers)
void getStatus (out boolean isInCluster, out boolean isError)

Member Function Documentation

void kerio::jsonapi::admin::DistributedDomain::connect ( out ClusterError  result,
in string  hostName,
in string  adminUser,
in string  password 
)

Connect server to cluster as slave.

Parameters
result- if ClusterErrorType is not clSuccess, error argument contains additional error info
hostName- name of the master server
adminUser- username of administrator on the master server
password- administrator's password
void kerio::jsonapi::admin::DistributedDomain::copy ( in string  domainName)

Copy domain from the master server.

Parameters
domainName- name of the domain on the master server that you want to copy. Name can be obtained by using method getDomainsFromServer.
void kerio::jsonapi::admin::DistributedDomain::disconnect ( )

Disconnect server from the cluster.

void kerio::jsonapi::admin::DistributedDomain::getDistributable ( out kerio::web::StringList  domainNames,
in ClusterAuthentication  authentication,
in boolean  connected 
)

Retrieve domains, which can be distributed, from the master server as a standalone server.

Parameters
domainNames- List of domains which can be distributed (they have a directory service set).
connected- true means the caller is connected to cluster
authentication- Structure with a credential. Credential will be used when connected is false.
void kerio::jsonapi::admin::DistributedDomain::getHomeServerList ( out HomeServerList  servers)

Retrieve information about servers in the cluster.

Parameters
servers- List of all servers in cluster.
void kerio::jsonapi::admin::DistributedDomain::getRole ( out ClusterRole  role,
out boolean  isMultiServer 
)

Return server role in the cluster.

void kerio::jsonapi::admin::DistributedDomain::getServerList ( out ClusterServerList  servers)

Retrieve information about servers in the cluster.

Parameters
servers- List of all servers in cluster.
void kerio::jsonapi::admin::DistributedDomain::getStatus ( out boolean  isInCluster,
out boolean  isError 
)

Retrieve true if the same server in cluster has an error.

Notes: This method fails if caller has not admin rights; This method fails if there is no cluster

Parameters
isInClustertrue if server is not standalone
isErrorstatus of error in cluster

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