TelemetryStatusDto

TelemetryStatusDto
TelemetryStatusDto

Current reporting status

JSON Example
{
    "state": "string",
    "lastAttemptAt": "string",
    "lastSuccessAt": "string",
    "lastResultCode": "string",
    "lastErrorMessage": "string",
    "consecutiveFailures": 0,
    "nextRunAt": "string",
    "pendingReports": 0
}
state
Required  

State of Broadcom usage reporting. There is no administrator-disabled value because basic reporting is mandatory.

  • ENABLED: The product credential is configured and the operator kill switch is off
  • DISABLED_BY_OPERATOR: The operator kill switch (configuration property) is on; it outranks a missing credential
  • NOT_CONFIGURED: The kill switch is off but no product credential is configured
Enumeration: ENABLED, DISABLED_BY_OPERATOR, NOT_CONFIGURED
string As date-time As date-time
lastAttemptAt
Optional

Time of the last upload attempt; omitted when no attempt was made

string As date-time As date-time
lastSuccessAt
Optional

Time of the last successful upload; omitted when none has succeeded

string
lastResultCode
Optional

Result code of the last send cycle: SENT, UNAUTHORIZED, INVALID_SERIAL, NOT_FOUND, REJECTED, THROTTLED or FAILED; omitted when no cycle ran

string
lastErrorMessage
Optional

Fixed explanation of the last failed upload; omitted when the last cycle succeeded or no cycle ran

integer As int32 As int32
consecutiveFailures
Required  

Number of failed send cycles in a row; reset to 0 by a successful cycle

string As date-time As date-time
nextRunAt
Optional

Next scheduled run: a pending retry time when it is in the future, otherwise the next daily generation time (00:00 UTC plus the installation's send-time jitter)

integer As int32 As int32
pendingReports
Required  

Number of stored reports whose status is PENDING or FAILED