pctconfig

Configure settings for Parallel Computing Toolbox client session

Syntax

pctconfig('p1', v1, ...)
config = pctconfig('p1', v1, ...)
config = pctconfig()

Arguments

p1

Property to configure. Supported properties are 'portrange', 'hostname'.

v1

Value for corresponding property.

config

Structure of configuration value.

Description

pctconfig('p1', v1, ...) sets the client configuration property p1 with the value v1.

Note that the property value pairs can be in any format supported by the set function, i.e., param-value string pairs, structures, and param-value cell array pairs. If a structure is used, the structure field names are the property names and the field values specify the property values.

If the property is 'portrange', the specified value is used to set the range of ports to be used by the client session of Parallel Computing Toolbox™ software. This is useful in environments with a limited choice of ports. The value of 'portrange' should either be a 2-element vector [minport, maxport] specifying the range, or 0 to specify that the client session should use ephemeral ports. By default, the client session searches for available ports to communicate with the other sessions of MATLAB® Distributed Computing Server™ software.

If the property is 'hostname', the specified value is used to set the hostname for the client session of Parallel Computing Toolbox software. This is useful when the client computer is known by more than one hostname. The value you should use is the hostname by which the cluster nodes can contact the client computer. The toolbox supports both short hostnames and fully qualified domain names.

config = pctconfig('p1', v1, ...) returns a structure to config. The field names of the structure reflect the property names, while the field values are set to the property values.

config = pctconfig(), without any input arguments, returns all the current values as a structure to config. If you have not set any values, these are the defaults.

Examples

View the current settings for hostname and ports.

config = pctconfig()
config = 
    portrange: [27370 27470]
     hostname: 'machine32'

Set the current client session port range to 21000-22000 with hostname fdm4.

pctconfig('hostname', 'fdm4', 'portrange', [21000 22000]);

Set the client hostname to a fully qualified domain name.

pctconfig('hostname', 'desktop24.subnet6.companydomain.com');

More About

expand all

Tips

The values set by this function do not persist between MATLAB sessions. To guarantee its effect, call pctconfig before calling any other Parallel Computing Toolbox functions.

Was this topic helpful?