Creating Scenarios: create_scenario

SOAP APIs › Scenario Management APIs › Creating Scenarios: create_scenario_ex()

Creating Scenarios: create_scenario_ex()

The create_scenario_ex API function lets you create scenarios. After you create scenarios, you can perform operations such as running the scenario, changing the scenario properties, adding or removing hosts, and so on.

Arguments

The create_scenario_ex 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.
product	uint	Specify an integer value for the following products: 0 - DR scenario 1 - HA scenario 2 - CD scenario
application	uint	Specify an integer value for the following applications: 0 - File server scenario. 1- Exchange scenario 2 - Oracle scenario 3 - Not used 4 - SQL server scenario 5 - IIS scenario 6 - Control Service scenario 7 - Hyper-v scenario 8 - Sharepoint scenario 9 - vCenter scenario 10 - CRM scenario 11- Full system scenario 12 - Customize scenario
is_ar	bool	Specifies whether the scenario supports assured recovery (AR): true: supports AR false: does not support AR
is_cdp	bool	Always false, not used.
integrate_opt	uint	Specify a real integer value for the following applications: 0 - No integration 1 - Backup 2 - Arcserve D2D 3 - Arcserve Central Applications
group_id	uint	Group ID. When the group_id is 0xFFFFFFFF, the scenario belongs to the default scenario group, which is usually named scenarios.
scenario_data	out string	The data for the scenario. After calling this API, the argument contains the updated scenario data. Note: For more information, see Example in this topic.
group_data	out string	The group data.

Return Values

This API returns the scenario ID that was created. The other APIs, such as run and stop require the scenario id. When the scenario id is zero, the API failed. Else, non-zero values indicate that the API completed successfully.

Note: When this API call completes successfully, the skeleton of the scenario is created. All of the properties for the scenario have the default values. Important properties such as the root directory, the host IP, and so on are empty. You call other APIs to fulfill the properties. The subsequent APIs in this reference guide describe how to fulfill the properties.

Example

uint product = 0;
                uint app = 0;
                bool is_ass_rec = false;
                bool is_cdp = false;
                uint si_opt = 0;
                uint group_id = 0xFFFFFFFF;
                string scenario_data = "";
                string group_data = "";
                
                uint  scenario_id =  get_mng().create_scenario_ex(_session_id, product, app, is_ass_rec, is_cdp, si_opt, group_id, out scenario_data, out group_data);