AgentSoftwareCheckJob

AgentSoftwareCheckJob
AgentSoftwareCheckJob

One targeted Agent software check. Every count describes this run, not the stored status. Jobs are held in memory and not persisted.

JSON Example
{
    "jobId": "string",
    "status": "string",
    "total": 0,
    "completed": 0,
    "installed": 0,
    "notInstalled": 0,
    "heldInstalled": 0,
    "shared": 0,
    "inconclusive": 0,
    "hosts": [
        {
            "hypervisorId": 0,
            "hostname": "string",
            "source": "string",
            "outcome": "string",
            "reason": "string"
        }
    ],
    "startedAt": "string",
    "completedAt": "string"
}
string
jobId
Required  

Identifier to poll with GET /api/v1/hypervisors/agent-software-checks/{jobId}

string
status
Required  

RUNNING while hosts remain. COMPLETED when this run confirmed or shared every host. COMPLETED_WITH_GAPS when any host was held or inconclusive. FAILED when the job stopped on an error.

Enumeration: RUNNING, COMPLETED, COMPLETED_WITH_GAPS, FAILED
integer As int32 As int32
total
Required  

Hosts in the job

integer As int32 As int32
completed
Required  

Hosts the job has finished with so far

integer As int32 As int32
installed
Required  

Hosts this run confirmed Installed

integer As int32 As int32
notInstalled
Required  

Hosts this run confirmed Not installed

integer As int32 As int32
heldInstalled
Required  

Hosts whose check timed out while the earlier Installed status was kept

integer As int32 As int32
shared
Required  

Hosts covered by another check, not verified by this run

integer As int32 As int32
inconclusive
Required  

Hosts this run could not confirm

hosts
Required  

One entry per host, in selection order

string As date-time As date-time
startedAt
Required  

Time the job started

string As date-time As date-time
completedAt
Optional

When the last host finished; null while running