The set_scenario_data API function lets you edit the scenario property. Most of the properties of the scenario can be updated by this API.
Arguments
The set_scenairo_data 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_id |
uint |
The ID of the scenario. |
property_name |
string |
The property name of the host. Each property has a unique name. |
property_value |
string |
The value of the property. |
Return Values
This function returns a value of true when the API call completes successfully. Otherwise, this function returns a value of false.
Example: Set scenario properties
//set scenario data properties get_mng().set_scenario_data(_session_id, scenario_id, "Scenario.ReplicateCompressAttr", "True");
The following table lists common scenario property names.
Property Name |
Description |
---|---|
Scenario.ScenarioName |
The scenario name |
Scenario.BuildShares |
Synchronize the windows share |
Scenario.SyncADS |
Replicate NTFS ADS |
Copyright © 2015 Arcserve.
All rights reserved.
|
|