Adding Replicas: add

SOAP APIs › Scenario Management APIs › Adding Replicas: add_replica()

Adding Replicas: add_replica()

The add_replica API function lets you add a new replica host for the scenario. If you want to replicate the master data to more than one replica host, you can call this API to add some replica hosts.

Arguments

The add_replica API function includes the arguments described in the following table:

Name	Type	Description
session_id	uint	The session ID that was returned by calling the create_session function API.
scenario_data	ref string	The data for the scenario. After calling this API, the argument contains the updated scenario data.
host_index	uint	The parent host index; the master host index is always 1; the first replica usually is 2.
new_replica_index	out uint	The index of the newly added replica host

Return Values

This function returns a value of true when the API call completes successfully. Otherwise, this function returns a value of false.

Example: Adding a replica

//add one replica under the master host
get_mng().add_replica(_session_id, ref scenario_data, master_host_index, out new_replica_index);