Dashboard > Pulse v2.1 > ... > Remote API Functions > RemoteApi.enableAgent
  Pulse v2.1 Log In | Sign Up   View a printable version of the current page.  
  RemoteApi.enableAgent
Added by Jason Sankey, last edited by Jason Sankey on Mar 19, 2009
Labels: 
(None)

Pulse Manual Index

Synopsis

boolean enableAgent(string token, string name)

Parameters

Parameter Type Description
token string Authentication token (see RemoteApi.login).
name string The name of the agent to enable.

Returns

boolean: True.

Faults

Fault Type Fault Reason
IllegalArgumentException If the given agent does not exist.

Description

Enables a given disabled agent, allowing it to once more begin processing builds. If the agent is curently marked to disable on idle, it will be returned to the building state.

Access

Available to users with disable permission for the given agent.

See Also

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