Synopsis
Parameters
| Parameter |
Type |
Description |
| token |
string |
Credentials, see RemoteApi.login. |
| agentName |
string |
The name of the agent to query. |
Returns
The current status of the agent, which will be one of:
- disabled
- offline
- version mismatch
- token mismatch
- invalid master
- building
- idle
Description
Returns the current status of the named agent. The agent will not be directly queried when this function is called, rather the status of the last automatic ping will be returned.
Access
Accessible to users with server administration privileges.
