ExecutionTask - addNshParamOverrideByName
ExecutionTask - addNshParamOverrideByName
Description :
This command will setup an override in the execution task for a particular NSH Script parameter name associated with the NSH Script Job in this task. It will allow you to set the state of the skipFlag and skipValue fields of the parameter and will also let you override the value if needed. The value is optional and can be set to "" when not overriding it. The skipFlag argument must be set to false if the NSH Script has the 'Parameter flag required at runtime' option enabled. The skipValue argument must be set to false if the NSH Script has the 'Value required at runtime' option enabled.
Return type : void
Command Input :
Variable Name | Variable Type | Description |
|---|---|---|
groupPath | String | Path to group containing the execution task. |
etName | String | Name of the execution task. |
nshParamName | String | NSH Script parameter name. |
skipFlag | Boolean | Value of the skipFlag option. Set to true to not include the flag, false otherwise. |
skipValue | Boolean | Value of the skipValue option. Set to true to not include the value, false otherwise. |
value | String | Actual value to use for the parameter. Overrides both the job value and script default value. |
Example
The following example shows how to set an override for the execution task TestET contained in group /tasks. It sets the skipFlag option to false, the skipValue option to true, and the value to new-default for the NSH Script parameter with name paramName.
Script
blcli ExecutionTask addNshParamOverrideByName /tasks TestET paramName false true new-default