Help Page Home

# AgentModel

An App Orchestration agent. Agents are machines that periodically read workflows and execute the steps contained within, to bring the components into compliance with the DesiredState.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | See Hypermedia. | Type: String
RelatedActions | See Hypermedia. | Type: Array of RelationModel
Id | ID of the agent. | Type: String
Name | Name of the machine on which the agent resides. | Type: String
Role | The agent role. | Type: String
Scope | The agent scope. | Type: String
IsPrimary | If true, the agent is the "Primary" agent in the scope. Only the Primary agent executes workflows. If the Primary agent stops responding, App Orchestration will elect a new Primary agent in that scope. | Type: Boolean
LastHeartBeatTime | The last time the agent successfully reported in. | Type: String (ISO 8601 standard date)
IsAlive | If true, the agent is considered "alive" due to having reported in recently. | Type: Boolean
IsHealthy | If true, the agent is considered "healthy" due to its most recent environment checks completing successfully. | Type: Boolean

### Sample

#### application/json

Sample:

    {
      "Href": "[api:Agents(941e92f1-5dd6-4720-bca2-6875c8b04acd)]",
      "Id": "941e92f1-5dd6-4720-bca2-6875c8b04acd",
      "Name": "SERVER1",
      "Role": "ControllerAgent",
      "Scope": "745c2030-77c6-4d65-97ac-52c79db96ff5",
      "IsPrimary": true,
      "LastHeartBeatTime": "2013-12-05T16:13:07.972934-05:00",
      "IsAlive": true,
      "IsHealthy": true
    }