EndpointSummary

EndpointSummary
EndpointSummary

Summary representation of an endpoint in inventory listing

JSON Example
{
    "id": "string",
    "hostname": "string",
    "ipAddress": "string",
    "macAddress": "string",
    "agentVersion": "string",
    "inventoryAssociation": "string",
    "esxiVersion": "string",
    "lifecycleState": "string",
    "commStatus": "string",
    "healthStatus": "string",
    "policySyncState": "string",
    "appliedPolicyVersion": 0,
    "agentDisabledStatus": false,
    "groupId": "string",
    "groupName": "string",
    "enforcementMode": "string",
    "lastHeartbeatAt": "string",
    "registeredAt": "string"
}
string
id
Required  

Unique external endpoint identifier (string-serialized 64-bit ID)

string
hostname
Required  

Host name recorded for the endpoint's agent

string
ipAddress
Optional

Primary IP address of the endpoint

string
macAddress
Optional

Primary MAC address of the endpoint

string
agentVersion
Optional

Installed VTP agent version

string
inventoryAssociation
Optional

CURRENT when a host in the current inventory is linked to this Agent; NOT_CURRENT when none is (the host was removed with its vCenter connection, or only a tombstone remains), so the record is a historical identity whose release this Console has not confirmed. Null when not computed.

Enumeration: CURRENT, NOT_CURRENT
string
esxiVersion
Optional

Host ESXi hypervisor version

lifecycleState
Required  

Administrative lifecycle state of the endpoint

  • ACTIVE: The endpoint is registered and has heartbeated; the default stored state, also set again by the next heartbeat of an OFFLINE endpoint
  • OFFLINE: The state stored when the endpoint is enrolled, until its first heartbeat
  • DELETED: The endpoint was retired by the Console; a retired endpoint no longer counts toward catalogued files' host counts
Enumeration: ACTIVE, OFFLINE, DELETED
commStatus
Optional

Communication status recorded for the agent; set ONLINE by each heartbeat and OFFLINE by the Console when the host is marked offline; null when no agent state exists

healthStatus
Optional

Agent health taken from the status the agent reported in its last heartbeat; null when no agent state exists

policySyncState
Optional

Whether the agent holds the policy of its current Security Group; null when no agent state exists, which is the Not reporting set that the policySyncState=NOT_REPORTING list filter returns

integer As int64 As int64
appliedPolicyVersion
Optional

Policy version of the Security Group the agent last reported as applied, as recorded by the rules sync; null when no agent state exists

boolean
agentDisabledStatus
Optional

Whether this endpoint's agent is currently in the dormant "circuit breaker" state (rule evaluation unhooked entirely)

string
groupId
Optional

Associated security group identifier

string
groupName
Optional

Associated security group display name

enforcementMode
Optional

Active enforcement mode of the endpoint's assigned Security Group

string As date-time As date-time
lastHeartbeatAt
Optional

Last successful heartbeat timestamp as an ISO 8601 date-time with offset

string As date-time As date-time
registeredAt
Required  

Timestamp when the endpoint first registered as an ISO 8601 date-time with offset