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.
Additional Properties
The sample plugin scripts allow you to set these properties.
Properties for All Schedulers
Property | Description | Data Type |
---|---|---|
| Additional scheduler arguments for job submission. The sample plugin scripts add the value of this property to the scheduler submission string. | String |
| Option to indicate how you are authenticated when you connect to the cluster, specified as one of the following:
|
|
| Host name of the cluster machine that has the scheduler utilities to submit jobs. Use this if your cluster is unable to directly submit jobs to the scheduler. The cluster machine must run Linux. | String |
| Option to display the job submission flags and options you pass to the scheduler when you submit a job. The flags and options are displayed on the command line. | Logical |
| Location on the client machine of the SSH identity file that identifies you on the cluster host machine. |
|
| Option to use passphrase for identity file. Set
this property to | Logical |
| Location to store job files on the cluster. Use this property if your client and the cluster nodes do not have a shared file system. | String |
| Cluster host port number for SSH connections. Use this property to set the port on the cluster host to connect to via SSH. | Double |
| Option to use an identity file. Set this property
to | Logical |
| User name to log in to the cluster host machine. | String |
| Option to use unique subfolders. Set this property
to | Logical |
Properties Specific to Each Scheduler
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 programmatically 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");
For other examples of modifying the functionality of your plugin
scripts at run time using the AdditionalProperties
property, see Adding User Customization (Parallel Computing Toolbox).
Related Topics
- Configure Using the Generic Scheduler Interface
- Plugin Scripts for Generic Schedulers (Parallel Computing Toolbox)