Client Commands

Login

Provides authentication information to the server. This username and password are specified in the dge.xml configuration file.

Login <login_id> | <password>

Logout | Quit

Ends a login session.

session.Logout

Result.insert

Inserts a result value for an existing test into the database. The Result.insert must be submitted to the EDF listener on the DGE that is monitoring the device.

Result.insert device_name | device_addr | test_name | test_serial | date_time | result_value

where

• device_name is the descriptive name that was used when the device was provisioned.
• device_ip is the fully qualified address or ip address that was used when provisioning the device.
• test_name, along with device_name and device_ip are used to obtain the unique serial number for the test if test_serial is not provided. This is the descriptive test name that was used during provisioning.
• test_serial is the unique serial number of the test, which should be already provisioned. If no serial number is provided, the device name, address and test name (if provided) will be used to obtain the test serial number. If no test matching the serial number can be found, the result value will be ignored.
• date_time is provided either in yyyy.mm.dd-hh:mm, or nnnnnnnnnn format where nnnnnnnnnn is the number of seconds since 1970. If the date and time are not provided, or a value of 0 is used, current system time in GMT is used. Because of the real-time aggregation, you must provide a timestamp newer than the last data value for the test.
• result_value is the value which should be inserted into the database. The provided result will be multiplied by the result multiplier, and processed in the manner set via process-directive, both set during the creation of the test.result_value may be set to several special values to represent differing states in Traverse:

Example

The device and test need to be created in Traverse using either the web interface (under the Advanced Tests section) or the BVE Server. The testType should be set to external for EDF tests.

% telnet bve_host 7661

OK 200 Traverse BVE TCP Server v5.0 ready

LOGIN traverse/traverse

OK 201 request accepted and processed, ready for next request

DEVICE.CREATE "devicename=my_device", "address=192.168.123.25",

"devicetype=unix", "snmpcid=public", "comment=my workstation",

"locationName=Denver Office"

OK 201 request accepted and processed, ready for next request

TEST.CREATE "devicename=my_device", "testname=my_test",

"testtype=external", "subtype=external", "interval=15m", "units=xyz",

"warningThreshold=55", "criticalThreshold=85", "maxvalue=100",

"resultProcessDirective=0", "resultMultiplier=1"

OK 201 request accepted and processed, ready for next request

QUIT

Now connect to the EDF server on port 7657 on the DGE that is monitoring the device. Use the username and password in the dge.xml configuration file, which is different from the one we used to access the BVE Server in the first step. Note that we are not using the test serial number and are also specifying the timestamp as 0 which indicates use current date and time.

% telnet dge_host 7657

OK Traverse External Data Feed Server Ready

login edfuser|fixme

OK

result.insert my_device | 192.168.123.25 | my_test | | 0 | 25

OK

QUIT

OK Received logout - bye

To view the newly inserted test result via BVE Server:

% telnet bve_host 7661

OK 200 Traverse BVE TCP Server v5.0 ready

login zyrion/zyrion

OK 201 request accepted and processed, ready for next request

RESULT.SEARCH "devicename=my_device", "testname=my_test", "starttime=NOW"

OK 203 request accepted, records returned: 1

my_device|470000|my_test|470003|external|external|20030506100124|1|25|25|25|Ok|55|85

QUIT

OK 299 Logging out.