shutdown

Shut down cloud cluster

Syntax

shutdown(cluster)

shutdown(MJScluster,'At',D)

shutdown(MJScluster,'After',event)

shutdown(MJScluster,'After',numhours)

Description

shutdown(cluster) shuts down the cluster immediately.

shutdown(MJScluster,'At',D) shuts down the cluster at the time specified by the datetime, datenum, or datevec D. D is interpreted in the local time zone of the MATLAB^® client unless D is a datetime with a non-empty TimeZone property.

shutdown(MJScluster,'After',event) shuts down the cluster after the specified event event has occurred. event can be 'never' or 'idle'. A cluster is 'idle' immediately when there are no running jobs, queued jobs, or running pools. The cluster is eligible for shutdown if 'idle' for more than 5 minutes, and is guaranteed to shut down within 60 minutes.

shutdown(MJScluster,'After',numhours) shuts down the cluster after numhours hours, as measured from the time the method is called.

Examples

Shut Down a Cloud Cluster Immediately

shutdown(cluster);

Shut Down Cluster at Date and Time Specified

Specify date and time to terminate a cluster using a datetime. If the datetime has an empty TimeZone property, the datetime is interpreted in the local time zone of the MATLAB client.

shutdown(MJSCluster,'At',datetime(2017,2,22,19,0,0,'TimeZone','local'));

Enable Cluster to Run Indefinitely

shutdown(MJSCluster,'After','never');

Shut Down When Cluster Is Idle

shutdown(MJSCluster,'After','idle');

Shut Down Cluster After a Number of Hours

shutdown(MJSCluster,'After',10);

Input Arguments

cluster — MATLAB Parallel Server™ for Cloud Center cluster

cluster object (default)

MATLAB Parallel Server for Cloud Center cluster, specified as cluster object created using parcluster.

Example: shutdown(cluster);

MJScluster — MATLAB Parallel Server for Cloud Center cluster

cluster object (default)

MATLAB Parallel Server for Cloud Center cluster, specified as cluster object created using parcluster.

Example: shutdown(MJScluster);

D — Date and time

datetime | datenum | datevec

Date and time, specified as a datetime, datenum, or datevec. D is interpreted in the local time zone of the MATLAB client unless D is a datetime with a non-empty TimeZone property.

Example: shutdown(MJSCluster,'At',datetime(2017,2,22,19,0,0,'TimeZone','local'));

event — Event to shut down the cluster

'never' | 'idle'

Event to shut down the cluster, specified as 'never' or 'idle'. A cluster is 'idle' immediately when there are no running jobs, queued jobs, or running pools. The cluster is eligible for shutdown if 'idle' for more than 5 minutes, and is guaranteed to shut down within 60 minutes.

Example: shutdown(MJSCluster,'After','idle');

numhours — Number of hours

scalar

Number of hours after which the cluster shuts down, specified as scalar, measured from the time you call shutdown.

Example: shutdown(MJSCluster,'After',10);

Version History

Introduced in R2017a