Synopsis
Parameters
| Parameter |
Type |
Description |
| token |
string |
Authentication token (see RemoteApi.login). |
| name |
string |
The name of the agent to disable. |
Returns
boolean: True.
Faults
| Fault Type |
Fault Reason |
| IllegalArgumentException |
If the given agent does not exist. |
Description
Disables the given agent, preventing it from processing builds until it is reenabled. If the agent is currently running a build, it will be marked to disable on idle. If the agent is already marked to disable on idle, it will be forcably disabled (terminating the build with an error).
Access
Available to users with disable permission for the given agent.
See Also
