Customize Behavior of Sample Plugin Scripts

When using the generic scheduler interface, you can modify the behavior of the plugin scripts by setting additional properties for a generic cluster profile or object using AdditionalProperties. For more information on the generic scheduler interface, see Configure Using the Generic Scheduler Interface.

The sample plugin scripts allow you to set the following properties.

Properties for All Schedulers

Property	Description	Type
`ClusterHost`	Host name of the cluster machine that has the scheduler utilities to submit jobs. This property is available in remote and nonshared submission modes only.	String
`RemoteJobStorageLocation`	Location to store job files on the cluster. This property is available in nonshared submission mode only.	String
`AdditionalSubmitArgs`	Additional scheduler arguments for job submission. The sample plugin scripts add the value of this property to the scheduler submission string.	String
`Username`	User name to log in to `ClusterHost` with.	String
`UseUniqueSubfolders`	Option to use unique subfolders. Set this property to `true` if you want MATLAB^® to store job files under different subfolders based on the user name and MATLAB version. Doing so helps to prevent conflicts between jobs submitted from different users and MATLAB versions.	Logical
`UseIdentityFile`	Option to use an identity file. Set this property to `true` if you want to use an SSH identity file to log in to `ClusterHost`. If you set this property, then also set `IdentityFile` and `IdentityFileHasPassphrase`.	Logical
`IdentityFile`	Location on the client machine of the SSH identity file that identifies you in `ClusterHost`.	String
`IdentityFileHasPassphrase`	Set this property to `true` if `IdentityFile` requires a passphrase.	Logical

Properties for PBS Only

Property	Description	Type
`ProcsPerNode`	Number of processor cores per node in the cluster. For most clusters, this is the number of physical cores per node. If you need more guidance, contact your cluster administrator.	Number

When you create a generic cluster profile for the first time with the Generic Profile Wizard, the installer guides you through setting some of these properties. For more information on the installer, see Interface with Third-Party Schedulers.

You can also define your own properties to customize the behavior of the plugin scripts. To do so, you must modify the plugin scripts. For more information, see Adding User Customization (Parallel Computing Toolbox).

Set Additional Properties

You can set additional properties in the cluster profile, with the Cluster Profile Manager, or programmatically.

Set Properties in Cluster Profile

When you set the additional properties in the cluster profile, the properties apply every time you use the cluster.

In the MATLAB toolstrip, on the Home tab, in the Environment area, select Parallel > Create and Manage Clusters.
In the Cluster Profile Manager, click on the generic profile that you want to modify.
Click Edit at the bottom-right.
Go to the AdditionalProperties table.
To add a new property, click Add. To modify an existing property, click on the property.

The following image shows an example of setting AdditionalSubmitArgs for an LSF^® cluster profile.

Set Properties Programmatically

You can set additional properties programatically by accessing the AdditionalProperties of a generic cluster object. Note that this action does not update the cluster profile and the properties only apply to that particular cluster object. The following is an example of how to set AdditionalSubmitArgs for an LSF cluster.

First, create a cluster object by using the parcluster function. In the following code, change MyLSFCluster to the name of your cluster profile.

c = parcluster("MyLSFCluster");

Next, set AdditionalSubmitArgs so that the plugin scripts use a different job queue.

c.AdditionalProperties.AdditionalSubmitArgs = '-q matlab_queue';

With this change, MATLAB passes the additional arguments to the scheduler when you submit a job. For example, submit a batch job.

job = batch(c,"myScript");

Documentation