21.9.11 smartpower_edit_scenario

Description

This Tcl command edits a custom scenario: scenario name, previously defined mode(s) and duration(s).

smartpower_edit_scenario -name {custom scenario name} \
                         [-description {description of scenario}] \
                         -mode {mode_name:duration} \
                         -new_name {New Scenario name}

Arguments

ParameterTypeDescription
namestringSpecifies the name of the scenario.
descriptionstringSpecifies the description of the scenario.
modestringSpecifies the mode(s) and duration(s) for the specified scenario. Possible values are {<operating mode>:<duration>}
new_namestringSpecifies the new name for the scenario.
Return TypeDescription
NoneNone

Error Codes

Error CodeDescription
NoneParameter 'new_name' has illegal value.
NoneParameter 'name' has illegal value.
NoneRequired parameter 'name' is missing.
NoneParameter 'param_name' is not defined. Valid command formatting is 'smartpower_edit_scenario -name "scenario name" [-description "description"] [-mode "":""]* [-new_name "new mode name"]'.

Supported Families

PolarFire®
SmartFusion® 2
RTG4™
IGLOO® 2
PolarFire SoC

Example

This example edits the name of "MyScenario" to "NewScenario":

smartpower_edit_scenario -name {MyScenario} -new_name {NewScenario} -mode "Active:100.00"

See Also