Share via

Task

Defines a task.

<xs:complexType name="Task">
    <xs:sequence>
        <xs:element name="EnvironmentVariables"
            type="NameValueCollection1"
            minOccurs="1"
            maxOccurs="1"
            nillable="true"
         />
        <xs:element name="ExtendedTerms"
            type="NameValueCollection"
            minOccurs="1"
            maxOccurs="1"
            nillable="true"
         />
    </xs:sequence>
    <xs:attribute name="AllocatedNodes"
        type="string"
        default=""
     />
    <xs:attribute name="RequiredNodes"
        type="string"
        default=""
     />
    <xs:attribute name="CommandLine"
        type="string"
     />
    <xs:attribute name="Depend"
        type="string"
        default=""
     />
    <xs:attribute name="ExitCode"
        type="int"
        default="0"
     />
    <xs:attribute name="Id"
        type="int"
        default="0"
     />
    <xs:attribute name="IsExclusive"
        type="boolean"
        default="false"
     />
    <xs:attribute name="IsRerunnable"
        type="boolean"
        default="false"
     />
    <xs:attribute name="MaximumNumberOfProcessors"
        type="int"
        default="1"
     />
    <xs:attribute name="MinimumNumberOfProcessors"
        type="int"
        default="1"
     />
    <xs:attribute name="ErrorMessage"
        type="string"
        default=""
     />
    <xs:attribute name="Name"
        type="string"
        default=""
     />
    <xs:attribute name="ParentJobId"
        type="int"
        default="0"
     />
    <xs:attribute name="Runtime"
        type="string"
        default="Infinite"
     />
    <xs:attribute name="Status"
        type="TaskStatus"
        default="NotSubmitted"
     />
    <xs:attribute name="Stdin"
        type="string"
        default=""
     />
    <xs:attribute name="Stdout"
        type="string"
        default=""
     />
    <xs:attribute name="Stderr"
        type="string"
        default=""
     />
    <xs:attribute name="WorkDirectory"
        type="string"
        default=""
     />
</xs:complexType>

Child elements

Element Type Description
EnvironmentVariables NameValueCollection1

Contains zero or more environment variables that are made available to the task. For details, see ITask::SetEnvironmentVariable.
ExtendedTerms NameValueCollection

Contains zero or more application-defined extended task terms. The terms can be accessed by the submission and activation filters. For details, see ITask::SetExtendedTaskTerm.

Attributes

Name Type Description
AllocatedNodes string

Comma-delimited list of nodes that are allocated to the task. For details, see IResourceUsage::get_AllocatedNodes. The attribute is passed to the activation filter but is ignored when calling the ICluster::CreateTaskFromXml method.
CommandLine string

The command line for the task. You must specify this attribute. For details, see ITask::put_CommandLine.
Depend string

Comma-delimited list of task names that must run before this task can run. For details, see ITask::put_Depend.
ErrorMessage string

The task error message set when a run-time error occurs or the task is canceled. For details, see ITask::get_ErrorMessage. This attribute is ignored when calling the ICluster::CreateTaskFromXml method.
ExitCode int

The exit code for the task. For details, see ITask::get_ExitCode. This attribute is ignored when calling the ICluster::CreateTaskFromXml method.
Id int

The task identifier. For details, see ITask::get_Id. Treat this attribute as read-only.
IsExclusive boolean

Indicates whether the task should run exclusively within the job on the node. For details, see ITask::put_IsExclusive.
IsRerunnable boolean

Indicates whether the task can be rerun after failure. For details, see ITask::put_IsRerunnable.
MaximumNumberOfProcessors int

The maximum number of processors required by the task. For details, see ITask::put_MaximumNumberOfProcessors.
MinimumNumberOfProcessors int

The minimum number of processors required by the task. For details, see ITask::put_MinimumNumberOfProcessors.
Name string

The display name of the task. For details, see ITask::put_Name.
ParentJobId int

The identifier of the parent job. This attribute is ignored when calling the ICluster::CreateTaskFromXml method.
RequiredNodes string

Comma-delimited list of required nodes. For details, see ITask::put_RequiredNodes.
Runtime string

The run-time limit for the task. For details, see ITask::put_Runtime.
Status TaskStatus

The task status. For details, see ITask::get_Status. This attribute is ignored when calling the ICluster::CreateTaskFromXml method.
Stderr string

Path to the file to use for standard error. For details, see ITask::put_Stderr.
Stdin string

Path to the file to use for standard input. For details, see ITask::put_Stdin.
Stdout string

Path to the file to use for standard output. For details, see ITask::put_Stdout.
WorkDirectory string

The startup directory for the task. For details, see ITask::put_WorkDirectory.

Remarks

The Task element is of this type.

Requirements

Product

Compute Cluster Pack Client Utilities

See also

Task Schema Complex Types