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

Pulse Manual Index

Synopsis

boolean disableAgent(string token, string agentName)

Parameters

Parameter Type Description
token string Credentials, see RemoteApi.login.
agentName string The name of the agent to disable.

Returns

True.

Description

Disables the given agent. When an agent is disabled, pulse™ will not ping the agent, and will not dispatch any recipes to it. See also RemoteApi.enableAgent.

Access

Accessible to users with server administration privileges.

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