DeviceStatusGetSchema
object
alarmSeverityenumOptional
The most severe alarm level last reported by the device.
- 0 - Clear
- 1 - Info
- 2 - Warning
- 3 - Error
- 4 - Critical
Allowed values:01234
The a list of the <glossary:flow> names assigned to the device.
Show 1 propertyHide 1 property
namestringRequiredpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The name of a <glossary:flow> assigned to the device.
Information about the beamHA the device is connected to.
Show 4 propertiesHide 4 properties
activeControllerDeviceNamestringOptional1-64 characters
The name of the active controller device in the beamHA.
roleslist of stringsRequired0-3 items
The roles of the device in the beamHA (high availability) group.
statusstringOptional
The status of the beamHA group. Only returned for the active controller device.
unregisteredDeviceslist of stringsOptional
List of location IDs of devices that are part of the beamHA but not registered. Only returned for the active controller device.
Device capabilities based on software version and hardware.
Show 1 propertyHide 1 property
configurationBackupbooleanOptional
Whether the device supports configuration backup. Returns false for devices with beam software version older than 1.6.
currentSoftwareVersionstring or nullOptional<=255 characters
The current software version running on the device, as reported by the device.
Optional geolocation data for the device.
Show 1 propertyHide 1 property
coordinateslist of doublesRequired0-2 items
Co-ordinates that describe the geolocation (ISO 6709), an array of two floating point numbers [latitude(North - South), longitude(East - West)]. Set an empty array to clear the geolocation.
A list of the physical and virtual interfaces reported by the device. If an interface is referenced directly by a source or a destination, it may be continue to be present in the list even if the device no longer reports it. The
state field indicates if the interface is currently present on the device.Show 4 propertiesHide 4 properties
ipAddresseslist of stringsOptional
The IP address associated with this interface, if applicable.
namestringRequiredpattern: ^([^\s\/]{1,16}|[a-zA-Z][a-zA-Z0-9_]{1,255})$
The name of the interface on the device.
stateenumRequired
Whether the interface is currently present on the device. If an interface is referenced directly by a source or a destination, it may be continue to be present in the list even if the device no longer reports it.
Allowed values:NotPresentPresent
typeenumRequired
The type of the physical or virtual interface on the device (IP, SDI/ASI or RF).
Allowed values:IPSDIASIRF
lastContactstring or nullOptional
The last time the device contacted the system.
locationIdstring or nullOptionalpattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
The location id is the identity of the actual device that will be associated with this record. This can be used instead of the
shortCode field when registering an on-prem device. The location id does not change so this can be a simpler approach for large scale system administration.The preloaded software present on the device.
Show 7 propertiesHide 7 properties
downgradeCompatiblebooleanOptional
Whether switching to this release is safe from an underlying component perspective. False if this release has a lower minimum version requirement than the currently installed release. True when no suitable reference release can be found (fail open).
namestringRequired1-255 characters
The name of the preloaded software present on the device.
precentProgressintegerOptional0 to 100
Indication of coarse progress for states with a significant duration.
progressDetailsstringOptional<=255 charactersDefaults to
Additional information about states with a significant duration.
stateenumRequired
The current state of the preloaded software.
Allowed values:RequestedDownloadingDownloadedImportingPreloadFailedPreloadCancelledRemovingRemoved
upgradeCompatiblebooleanOptional
Whether the device's current software version meets the minimum version requirement for upgrading to this release. Mirrors the field on the device software list endpoint.
versionstringRequired<=255 characters
The version of the preloaded software.
rollbackSoftwareVersionstring or nullOptional<=255 characters
The rollback software version, as reported by the device.
secondsSinceLastContactinteger or nullOptional
The number of seconds since the last time the device contacted the system.
serialNumberstring or nullOptional1-255 characters
The serial number of the device, as reported by the device.
softwareNamestring or nullOptional0-255 characters
The name of the software installed on the device.
softwareUpgradeStateenumOptional
Indicates if a software upgrade is in progress or has failed.
Allowed values:IdleSwitchingSwitchFailed
urlstringOptional1-2048 characters
The URL to access the device's web interface remotely.