Synopsis
Parameters
| Parameter |
Type |
Description |
| token |
string |
Authentication token (see RemoteApi.login). |
| name |
string |
The name of the agent to retrieve the state for. |
Returns
string: The current state of the given agent.
Faults
| Fault Type |
Fault Reason |
| IllegalArgumentException |
If the given agent does not exist. |
Description
Returns the state of the given agent as a simple string. Possible states are:
- enabled
- disabled
- disabling
Access
Available to users with view permission for the given agent.
See Also
