Learn more about Parallel Computing Toolbox

Property Reference

Job Manager Properties

BusyWorkers	Workers currently running tasks
ClusterOsType	Specify operating system of nodes on which scheduler will start workers
ClusterSize	Number of workers available to scheduler
Configuration	Specify configuration to apply to object or toolbox function
HostAddress	IP address of host running job manager or worker session
HostName	Name of host running job manager or worker session
IdleWorkers	Idle workers available to run tasks
Jobs	Jobs contained in job manager service or in scheduler's data location
Name	Name of job manager, job, or worker object
NumberOfBusyWorkers	Number of workers currently running tasks
NumberOfIdleWorkers	Number of idle workers available to run tasks
State	Current state of task, job, job manager, or worker
Type	Type of scheduler object
UserData	Specify data to associate with object

Scheduler Properties

CancelJobFcn	Specify function to run when canceling job on generic scheduler
CancelTaskFcn	Specify function to run when canceling task on generic scheduler
ClusterMatlabRoot	Specify MATLAB root for cluster
ClusterName	Name of Platform LSF cluster
ClusterOsType	Specify operating system of nodes on which scheduler will start workers
ClusterSize	Number of workers available to scheduler
ClusterVersion	Version of HPC Server scheduler
Configuration	Specify configuration to apply to object or toolbox function
DataLocation	Specify directory where job data is stored
DestroyJobFcn	Specify function to run when destroying job on generic scheduler
DestroyTaskFcn	Specify function to run when destroying task on generic scheduler
EnvironmentSetMethod	Specify means of setting environment variables for mpiexec scheduler
GetJobStateFcn	Specify function to run when querying job state on generic scheduler
HasSharedFilesystem	Specify whether nodes share data location
JobDescriptionFile	Name of XML job description file for Microsoft Windows HPC Server scheduler
Jobs	Jobs contained in job manager service or in scheduler's data location
JobTemplate	Name of job template for HPC Server 2008 scheduler
MasterName	Name of Platform LSF master node
MatlabCommandToRun	MATLAB command that generic scheduler runs to start lab
MpiexecFileName	Specify pathname of executable mpiexec command
ParallelSubmissionWrapperScript	Script that scheduler runs to start labs
ParallelSubmitFcn	Specify function to run when parallel job submitted to generic scheduler
RcpCommand	Command to copy files from client
ResourceTemplate	Resource definition for PBS Pro or TORQUE scheduler
RshCommand	Remote execution command used on worker nodes during parallel job
SchedulerHostname	Name of host running Microsoft Windows HPC Server scheduler
ServerName	Name of current PBS Pro or TORQUE server machine
SubmitArguments	Specify additional arguments to use when submitting job to Platform LSF, PBS Pro, TORQUE, or mpiexec scheduler
SubmitFcn	Specify function to run when job submitted to generic scheduler
Type	Type of scheduler object
UserData	Specify data to associate with object
UseSOAJobSubmission	Allow service-oriented architecture (SOA) submission on HPC Server 2008 cluster
WorkerMachineOsType	Specify operating system of nodes on which mpiexec scheduler will start labs

Job Properties

Configuration	Specify configuration to apply to object or toolbox function
CreateTime	When task or job was created
FileDependencies	Directories and files that worker can access
FinishedFcn	Specify callback to execute after task or job runs
FinishTime	When task or job finished
ID	Object identifier
JobData	Data made available to all workers for job's tasks
MaximumNumberOfWorkers	Specify maximum number of workers to perform job tasks
MinimumNumberOfWorkers	Specify minimum number of workers to perform job tasks
Name	Name of job manager, job, or worker object
Parent	Parent object of job or task
PathDependencies	Specify directories to add to MATLAB worker path
QueuedFcn	Specify M-file function to execute when job is submitted to job manager queue
RestartWorker	Specify whether to restart MATLAB workers before evaluating job tasks
RunningFcn	Specify M-file function to execute when job or task starts running
StartTime	When job or task started
State	Current state of task, job, job manager, or worker
SubmitArguments	Specify additional arguments to use when submitting job to Platform LSF, PBS Pro, TORQUE, or mpiexec scheduler
SubmitTime	When job was submitted to queue
Tag	Specify label to associate with job object
Task	First task contained in MATLAB pool job object
Tasks	Tasks contained in job object
Timeout	Specify time limit to complete task or job
UserData	Specify data to associate with object
UserName	User who created job

Task Properties

AttemptedNumberOfRetries	Number of times failed task was rerun
CaptureCommandWindowOutput	Specify whether to return Command Window output
CommandWindowOutput	Text produced by execution of task object's function
Configuration	Specify configuration to apply to object or toolbox function
CreateTime	When task or job was created
Error	Task error information
ErrorIdentifier	Task error identifier
ErrorMessage	Message from task error
FailedAttemptInformation	Information returned from failed task
FinishedFcn	Specify callback to execute after task or job runs
FinishTime	When task or job finished
Function	Function called when evaluating task
ID	Object identifier
InputArguments	Input arguments to task object
MaximumNumberOfRetries	Specify maximum number of times to rerun failed task
NumberOfOutputArguments	Number of arguments returned by task function
OutputArguments	Data returned from execution of task
Parent	Parent object of job or task
RunningFcn	Specify M-file function to execute when job or task starts running
StartTime	When job or task started
State	Current state of task, job, job manager, or worker
Timeout	Specify time limit to complete task or job
UserData	Specify data to associate with object
Worker	Worker session that performed task

Worker Properties

Computer	Information about computer on which worker is running
CurrentJob	Job whose task this worker session is currently evaluating
CurrentTask	Task that worker is currently running
HostAddress	IP address of host running job manager or worker session
HostName	Name of host running job manager or worker session
JobManager	Job manager that this worker is registered with
Name	Name of job manager, job, or worker object
PreviousJob	Job whose task this worker previously ran
PreviousTask	Task that this worker previously ran
State	Current state of task, job, job manager, or worker

waitForState

Properties — Alphabetical List

Recommended Products

Get MATLAB trial software

Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.

Get the Interactive Kit