*getServerStatus
Â
Configuration Article | CA-20220907-TP-66 VDG Sense | API | Functions | Status |
Note: This function requires an API license.
Returns information about the status of a specific server. If the parameter serverid is omitted, the information of the local server is returned. Tagged video is not deleted until released which must be done by a user in the system.
Request
command=getServerStatus&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>
<freespace>[number]</freespace>
<usedspace>[number]</usedspace>
            <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 | Â |
freespace | [number] | Â | *added in 2.7.3 |
usedspace | [number] | Â | *added in 2.7.3 |
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 |
Changelog
VDG Sense version 2.7.3 – Added freespace and usedspace parameters to the storage node
2.6.1 – Added storageretentiontime, firstrecordedimage & lastrecordedimage
2.4.2 – Added status by taggedvideo.
2.4.1 – Added