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>[number]</license>
        <devicestatuslist count="[number]"></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
license [number] license number
devicestatuslist [number] the number of devicestatus objects
/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.4.2 – Added