ICluster.ModifyJobTerm Method

Article
04/17/2009

Modifies the specified job term.

Namespace: Microsoft.ComputeCluster
Assembly: CcpAPI (in ccpapi.dll)

Usage

Syntax

'Declaration
Sub ModifyJobTerm ( _
    jobId As Integer, _
    termName As String, _
    termValue As String _
)

void ModifyJobTerm (
    int jobId,
    string termName,
    string termValue
)

void ModifyJobTerm (
    int jobId, 
    String^ termName, 
    String^ termValue
)

void ModifyJobTerm (
    int jobId, 
    String termName, 
    String termValue
)

function ModifyJobTerm (
    jobId : int, 
    termName : String, 
    termValue : String
)

Parameters

jobId
The job identifier. The ICluster.AddJob method returns this value. If you have an instance of the job that has already been added to the cluster, you can access the IJob.Id property to get the identifier.

termName
The name of the job term. The name is case sensitive. For a list of possible terms, see Remarks.

termValue
The value of the job term.

Remarks

The following is the list of job terms that you can modify.

Job term	Description
AskedNodes	A comma-delimited list of nodes that your job requires. The node must exist in the cluster.
IsExclusive	Indicates whether nodes are exclusively allocated to a job. The default is True.
Name	The display name for the job.
SoftwareLicense	The required license features. The format is string:integer{,string:integer}.
MaximumNumberOfProcessors	The maximum number of processors to be reserved for the job. The default is 1.
MinimumNumberOfProcessors	The minimum number of processors to be reserved for the job. The default is 1.
Priority	The priority of the job relative to other jobs in the queue. Possible values are: Highest, AboveNormal, Normal, BelowNormal, and Lowest. The default value is Normal.
Project	The project name that is associated with the job for accounting purposes.
RunUntilCanceled	Indicates whether the resources allocated to a job are reserved until the job is canceled (even if the job has no active tasks). The default is False.
Runtime	The run-time limit for the job. Can be Infinite or a string in the format dd:hh:mm.

If you specify a term that is not in the list, the method searches for a matching extended term (see the IJob.SetExtendedJobTerm property). If the extended term is found, its value is updated; otherwise, the job term is added to the list of extended terms for the job. The names of extended terms are case insensitive.

If the job is running, you can modify only the IJob.Runtime, IJob.RunUntilCanceled, and IJob.Project job properties. The changes take effect immediately. If the job is a backfill job (see the IJob.IsBackfill property), you cannot modify the Runtime property.

This method updates the job on the cluster. If you have an instance of the job object at the time you called this method, the instance will not reflect the update. You will need to retrieve a new instance of the job object to see the change.

To modify all the properties of a job, call the ICluster.ModifyJob method.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003, Windows XP

Target Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003 with Compute Cluster Pack Client Utilities, Windows XP with Compute Cluster Pack Client Utilities

Share via