getSystemStatus

Get the systemstatus of all servers. If the parameter serverid is set, the systemstatus of this server will be displayed.

Note: This function requires an API license.

This function obtains the status of the “whole” Sense VMS system, while getServerStatus will only return the status of one single server.

Request

Note: serverid is optional.

command=getSystemStatus&serverid=[UID]

Response

<result errorcode="0">
    <systemstatus>
        <id>[UID]</id>
        <license>
            <issenselicense>[boolean]</issenselicense>
            <productid>[string]</productid>
            <producttype>[string]</producttype>
            <productversion>[string]</productversion>
            <productlicensecreationdate>[YYYY-MM-DD]</productlicensecreationdate>
            <productlicenseextendedwarrantydate>[YYYY-MM-DD]</productlicenseextendedwarrantydate>
            <productlicenseexpirationdate>[YYYY-MM-DD]</productlicenseexpirationdate>
            <licensetype>[string]</licensetype>
            <maxstorage>[number]</maxstorage>
            <videochannels>[number]</videochannels>
            <audiochannels>[number]</audiochannels>
            <iodevices>[number]</iodevices>
            <commendchannels>[number]</commendchannels>
            <nativeclients>[number]</nativeclients>
            <mobileclientsregistered>[number]</mobileclientsregistered>
            <mobileclientsconnections>[number]</mobileclientsconnections>
            <carrchannels>[number]</carrchannels>
            <facerchannels>[number]</facerchannels>
            <objectrbasicchannels>[number]</objectrbasicchannels>
            <objectradvancedchannels>[number]</objectradvancedchannels>
            <lenel>[boolean]</lenel>
            <aid>[boolean]</aid>
            <api>[boolean]</api>
        </license>
        <devicestatuslist count="[number]">
            <id>[uid]</id>
            <name>[string]</name>
            <state>[string]</state>
            <storageretentiontime>[XML Time period format]</storageretentiontime>
            <firstrecordedimage>[timestamp]</firstrecordedimage>
            <lastrecordedimage>[timestamp]</lastrecordedimage>
        </devicestatuslist>
        <storage>
            <info>[string]</info>
            <storagesize>[number]</storagesize>
            <blocksize>[number]</blocksize>
        </storage>
        <health>
            <memory>
                <info>[string]</info>
                <load>[number]</load>
                <totalphys>[number]</totalphys>
                <availphys>[number]</availphys>
                <totalpagefile>[number]</totalpagefile>
                <availpagefile>[number]</availpagefile>
                <totalvirtual>[number]</totalvirtual>
                <availvirtual>[number]</availvirtual>
            </memory>
            <processmemory>
                <workingsetsize>[number]</workingsetsize>
            </processmemory>
            <cpu>
                <cores>[number]</cores>
                <load>[number]</load>
            </cpu>
            <network>
                <inputbandwidth>[number]</inputbandwidth>
                <outputbandwidth>[number]</outputbandwidth>
            </network>
            <harddisk>
                <readbandwidth>[number]</readbandwidth>
                <writebandwidth>[number]</writebandwidth>
            </harddisk>
        </health>
        <systeminfo>
            <oem-id>[UID]</oem-id>
            <numofprocessors>[number]</numofprocessors>
            <page-size>[number]</page-size>
            <processor-type>[number]</processor-type>
        </systeminfo>
        <serversettings>
            <managementserveraddress>[number]</managementserveraddress>
        </serversettings>
        <statusevents>
            <managementconnectionstatus>[string]</managementconnectionstatus></pre>
        </statusevents>
        <divaconnections>
            <connection>
                <IPAddress>[ip-address]</IPAddress>
                <type>[string]</type>
                <address>[ip-address]</address>
                <username>[string]</username>
                <divaid>[number]</divaid>
                <description>[string]</description>
            </connection>
        </divaconnections>
        <taggedvideo>
            <percentage>[number]</percentage>
            <status>[string]</status>
        </taggedvideo>
    </systemstatus>
</result>
node value remarks
/result
@errorcode [number] See error codes below
/result/systemstatus
id  [id] unique id of the systemstatus
/result/systemstatus/license
issenselicense [boolean] if the given license is a valid Sense license
productid [string] the product id of the Sense license
producttype [string] the license type. Can be "Start", "Basic" or "Pro"
productversion [string] the installed VDG Sense version
productlicensecreationdate [YYYY-MM-DD] the creation date of the Sense license
productlicenseextendedwarrantydate [YYYY-MM-DD] the expiry date of the extended warranty of the Sense license
productlicenseexpirationdate [YYYY-MM-DD] the expiry date of the Sense license
licensetype [string] internal identifier code for the license type
maxstorage [number] the maximum amount of storage that's allowed with this license (in hours)
videochannels [number] the maximum amount of video channels that's allowed with this license
audiochannels [number] the maximum amount of audio channels that's allowed with this license
iodevices [number] the maximum amount of io devices allowed with this license
commendchannels [number] the maximum amount of commend devices allowed with this license
nativeclients [number] the maximum amount of clients allowed with this license
mobileclientsregistered [number] the amount of mobile devices currently registered
mobileclientsconnections [number] the maximum amount of mobile client connections allowed with this license
carrchannels [number] the maximum amount of CarR devices allowed with this license
facerchannels [number] the maximum amount of FaceR devices allowed with this license
objectrbasicchannels [number] the maximum amount of ObjectR Basic channels allowed with this license
objectradvancedchannels [number] the maximum amount of ObjectR Advanced channels allowed with this license
lenel [boolean] [0|1] indicates if this license has POS options
tokheim [boolean] [0|1] indicates if this license has Tokheim options
aid [boolean] [0|1] indicates if this license has AID/Traffic options
api [boolean] [0|1] indicates if this license has extended API options
/result/systemstatus
devicestatuslist [number] the number of devicestatus objects
id [uid] unique id of the device
name [string] the name of the device
state [string] the status of the device
storageretentiontime [XML Time period format]  the total recorded time of the device
firstrecordedimage [yyyy-mm-dd hh:nn:ss.zzz] date & time of the first frame in the recorded data
lastrecordedimage [yyyy-mm-dd hh:nn:ss.zzz] date & time of the last frame in the recorded data
/result/systemstatus/storage
info [string] information about the storage values
storagesize [number] the number of storagesize
blocksize [number] the number of blocksize
/result/systemstatus/storage/health
/result/systemstatus/health/memory
info [string] information about the memory values
load [number] the number of the load memory
totalphys [number] the number of the total physical memory
availphys [number] the number of available physical memory
totalpagefile [number] the number of the total page files
availpagefile [number] the number of available page files.
totalvirtual [number] the number of the total virtual memory.
availvirtual [number] the number of available virtual memory
/result/systemstatus/health/processmemory
workingsetsize [number] the size of the working sets of the processmemory
/result/systemstatus/health/cpu
cores [number] cpu cores value
load [number] cpu load value
/result/systemstatus/health/network
inputbandwidth [number] width of inputband of the network
outputbandwidth [number] width of outputband of the network
/result/systemstatus/health/harddisk
readbandwidth [number] width of readband of the harddisk
writebandwidth [number] width of writeband of the harddisk
/result/systemstatus/systeminfo
oem-id [number] unique id of the mainboard
numofprocessors [number] the number of processors
page-size [number] the number of pages.
processor-type [number] the type of the processor.
/result/systemstatus/serversettings
managementserveraddress [number] the address of the managementserver
/result/systemstatus/statusevents
managementconnectionstatus [string] Connection status with management server
/result/systemstatus/divaconnections
/result/systemstatus/divaconnections/connection
IPaddress [ip-address]  The IP address of the DIVA server
type [string] type of server
address [ip-address]  The address of the server
username [string] The current logged in user
divaid [uid] Unique ID of the server
description [string] server description
/result/systemstatus/taggedvideo
percentage [number] the amount of tagged video in percentages
status [string] status of the tagged video (active, inactive)
error code description remarks
0 Ok Ok, no error

See Also

Changelog

  • 2.6.1 – Added storageretentiontime, firstrecordedimage & lastrecordedimage
  • 2.4.2 – Added