19 system information methods, 1 system service methods, System information methods -1 – Echelon i.LON SmartServer 2.0 User Manual

Page 301: System service methods -1, System service methods

Advertising
background image

i.LON SmartServer 2.0 Programmer’s Reference

19-1

19

System Information Methods

You can use the SystemService_Read_Info and SystemService_Write_Info functions in the
iLON100_System.wsdl to read system information about the SmartServer and modify the
SmartServer’s configuration. You can use the SystemService_Test function to test connections to
various host devices such as SMTP mail servers, SNTP time servers, and remote SmartServers and
read the results of the tests.

Note: To use the system information methods, you must reference the iLON100_System.wsdl in your
code. See Chapter 20, Using the SOAP Interface as a Web Service, for more information on adding
service references.

19.1

System Service Methods

You can use the SystemService_Read_Info and SystemService_Write_Info functions to read system
information about the SmartServer and modify the SmartServer’s configuration.

The SystemService_Read_Info and SystemService_Write_Info functions take a string consisting of an
<iLONSystemService> element that includes one <UCPTsystemInfoType> property. The
<UCPTsystemInfoType> property specifies an enumeration representing the type of system
information to be read from and written to the SmartServer. The following example demonstrates how
to use the SystemService_Read_Info function in your code:

string systemData = "<iLONSystemService><UCPTsystemInfoType>SI_TIME
</UCPTsystemInfoType></iLONSystemService>"

Tip: Section 21.1.7, Configuring the SmartServer in Visual C# .NET, includes a C# programming
example demonstrating how to use the SystemService_Read_Info and SystemService_Write_Info
functions. Section 21.2.7, Configuring the SmartServer in Visual Basic.NET, includes a Visual Basic
example demonstrating how to do this.

The following table lists the values to which you can set <UCPTsystemInfoType> and the type of
system information returned by the SystemService_Read_Info function:

<UCPTsystemInfoType> Data

Returned by SystemService_Read_Info

SI_NETWORK SmartServer

IP

connections, including IPv4, IPv6, and

DNS server connections.

SI_TIME

SmartServer real-time clock settings.

SI_SECURITY SmartServer

security settings.

SI_STATIC
(read-only)

General information about the SmartServer, including
the following:
• Hardware and firmware versions.
• Flash memory capacity and limits.
• FPM license status.

SI_REAL_TIME
(read-only)

General network performance statistics for the
SmartServer, including the following:
• Current flash memory usage.
• CPU utilization.
• Data point message failures.

Advertising