task

Task

Name of the task.

Y

retainSysIds

n/a

Specification for whether or not the Create a Simulation web service will persist the sysId property.

• If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.

• If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

In XML web services, retainSysIds is specified as an attribute in the <simulation> element.

Valid values: true/false (default is true).

N

workflow

Workflow

Name of the workflow.

N

vertexId

Vertex

Vertex ID of the task added to the workflow.

Defaults to ANY (-1) if not specified

N

status

Status

Projected simulation status.

Allowed values

• Success (200)

• Failed (140)

N

exitCode

Exit Code

Exit code to return.

Defaults to 0(zero) if not specified.

N

variables

Simulation Variables

Specifies variables that should be added for simulation purposes, including any built-in monitor variables starting with "ops_trigger_".

The Simulation Variables are for adding variables that the simulated instance would have normally produced, therefore, are only available after the instance is already Queued or Running.

List of variables: 

<variables>
       <variable>
             <name>env1</name>
             <value>test1</value>
       </variable>
       <variable>
             <name>env2</name>
             <value>test2</value>
       </variable>
</variables>

N

publishStatus

Publish Status

Specifies if Status events should be published to task monitor instances.

Defaults to false

N

publishLateStart

Publish Late Start

Specifies if Late Start events should be published to task monitor instances.

Defaults to false

N

publishLateFinish

Publish Late Finish

Specifies if Late Finish events should be published to task monitor instances.

Defaults to false

N

publishEarlyFinish

Publish Early Finish

Specifies if Early Finish events should be published to task monitor instances.

Defaults to false

N

abortActions

Execute Abort Actions

Specifies if Abort Actions should be executed for the simulated instance.

Defaults to false

N

emailNotificationActions

Execute Email Notification Actions

Specifies if Email Notification Actions should be executed for the simulated instance.

Defaults to false

N

variableActions

Execute Set Variable Actions

Specifies if Set Variable Actions should be executed for the simulated instance.

Defaults to false

N

snmpNotificationActions

Execute SNMP Notification Actions

Specifies if SNMP Notification Actions should be executed for the simulated instance.

Defaults to false

N

systemOperationActions

Execute System Operation Actions

Specifies if System Operation Actions should be executed for the simulated instance.

Defaults to false

N