Get Appliance System Info Operation

The getApplianceSystemInfo operation returns a result containing the system information on an Appliance.

Get Appliance System Info Request Parameters

The getApplianceSystemInfo operation request parameters are:

Parameter Description Values Required Type
authToken Unique authentication token.   Yes String
applianceIp The Appliance from which you retrieve the system information. IP address. For example:

10.1.2.3

Yes String

Example

SOAP request for Get Appliance System Info Operation: 

SOAP Request example in the LMI_eva_6.2_WebServicesAPI guide:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sys="SystemService">
   <soapenv:Header/>
   <soapenv:Body>
      <sys:getApplianceSystemInfo>
         <!--Optional:-->
         <sys:authToken>admin/admin123</sys:authToken>
         <!--Optional:-->
         <sys:applianceIP></sys:applianceIP>
      </sys:getApplianceSystemInfo>
   </soapenv:Body>
</soapenv:Envelope>

Get Appliance System Info Response Attributes

The getApplianceSystemInfo response attributes are:

Attribute Description Type
applianceIp Appliance IP. For example, "10.0.80.14". String
applianceModel Appliance model. For example, "LX2010". String
applianceTitle Appliance title. For example, "LX 2010 (Management Station)". String
applianceType Appliance type. For example, "LX". String
applianceVersion Appliance version. For example, "5.0.0". String
buildNumber Build number. For example, "201008071649\n". String
lspVersion LSP version. For example, "17.1.201003171111". String
lspVersionShort LSP version short string. For example, "17.1". String
logLineDelimiter Logline delimiter. For example, "\r\n". String
runningMode Values are one of: "ms", "non-ms", "strict-non-ms". String
underRemoteControl Indicate the appliance is under remote control or not. Boolean
applianceTimeZoneId Time zone ID. For example, “UTC”. String
currentApplianceTimeEpoch Current appliance time Epoch. For example, 1282241419646. Number
applianceTimeZoneOffsetSeconds Appliance timezone offset in seconds. Number
errorCause Error cause code of the error. Number
errorCode Error code for the request number. Number

Example

SOAP response for Get Appliance System Info Operation: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:getApplianceSystemInfoResponse xmlns:ns="SystemService">
         <ns:return xsi:type="ax231:SystemInfo" xmlns:ax231="http://system.services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax231:applianceIp>10.114.66.36</ax231:applianceIp>
            <ax231:applianceModel>MX4025</ax231:applianceModel>
            <ax231:applianceTimeZoneId>PST8PDT</ax231:applianceTimeZoneId>
            <ax231:applianceTimeZoneOffsetSeconds>-25200000</ax231:applianceTimeZoneOffsetSeconds>
            <ax231:applianceTitle>MX 4025</ax231:applianceTitle>
            <ax231:applianceType>MX</ax231:applianceType>
            <ax231:applianceVersion>6.3.0</ax231:applianceVersion>
            <ax231:buildNumber>20190307182612</ax231:buildNumber>
            <ax231:currentApplianceTimeEpoch>1552410519893</ax231:currentApplianceTimeEpoch>
            <ax231:errorCause>0</ax231:errorCause>
            <ax231:errorCode>0</ax231:errorCode>
            <ax231:logLineDelimiter>\r\n</ax231:logLineDelimiter>
            <ax231:lspVersion>34.1.201902201629</ax231:lspVersion>
            <ax231:lspVersionShort>34.1</ax231:lspVersionShort>
            <ax231:runningMode>non-ms</ax231:runningMode>
            <ax231:underRemoteControl>false</ax231:underRemoteControl>
         </ns:return>
      </ns:getApplianceSystemInfoResponse>
   </soapenv:Body>