Dashboard > Pulse v1.2 > ... > Remote API Functions > RemoteApi.shutdown
  Pulse v1.2 Log In | Sign Up   View a printable version of the current page.  
  RemoteApi.shutdown
 Browse Space
Added by Jason Sankey, last edited by Jason Sankey on Aug 21, 2006  (view change)
Labels: 
(None)

Pulse Manual Index

Synopsis

boolean shutdown(string token, boolean force)

Parameters

Parameter Type Description
token string Credentials, see RemoteApi.login.
force boolean If true, shut down immediately, forcefully terminating any active builds.

Returns

True.

Description

Starts the shutdown sequence for the pulse™ server. Normal shutdown will wait for all active builds to complete before the server exits. If force is true, the shutdown will force all running builds to terminate abruptly.

Access

Accessible to users with server administration privileges only.

Zutubi wiki is Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.2.10 Build:#528 Nov 29, 2006) - Bug/feature request - Contact Administrators