Using the API to change test limits

[lwilson]

I'm trying to figure out how to use the API to change thresholds for tests (warning level and error level) across all devices (Traverse only allows you to change tests one device at a time), but I can't find any documentation on the API. Just as a simple example, I want to change all interface utilization tests on all devices to go into "warning" state at 90% and "error" state at 110% (never).

A more complicated example is changing interface traffic tests in the same way, but this would require knowledge of the maximum possible value to determine what traffic level is 90% of the total.

Can anyone point me to some documentation that would help me with this, or could anyone help me directly?

[sysadmin]

Hi Luke,

In order to change the warning/critical thresholds for bandwidth utilization tests across all devices, you can use the following BVE API command:


test.update "devicename=*", "testname=*", "testtype=snmp", "subtype=bandwidth", "warningthreshold=90", "criticalthreshold=110"


Description of this and other BVE API commands are available in the Developer's Guide under the Documentation section of our Support Portal (http://zyrion.com/support/users/).

[lwilson]

Thank you. I am having some difficulty connecting to the BVE service, though. In a distributed environment, is the BVE supposed to run on the head-end server or on the DGEs? The documentations says it should be accessible on port 7661, but I can't get either our head-end machine or our DGEs to respond on that port. I looked at dge.xml, but I can't see where the BVE port is defined. All I see are the status server, the external data feed server, and the WMI query daemon.

[CJ Goldsmith]

Hi Luke,

The BVE API runs on the BVE or what you are calling the 'Head End' server (The server which is running Tomcat and serving web pages). The BVE API is typically not set to run by default and needs to be started manually. In windows this can be accomplished through the Traverse service controller. In linux you can start the BVE API via the following command:
[Traverse Home]/etc/bveapi.init start

You can also set this process to start automatically on system boot. Inside of the Windows OS this is a matter of opening the services controller and finding the 'Traverse BVE API' service and setting it to 'Automatic'. Within a Unix OS you need to edit the file located at [Traverse Home]/etc/traverse.init

Near the top of the file you will see something similar to the following:

PROVDB="Y"
BVEAPI="N"
MESSAGE="N"
DGE="N"
WEBAPP="Y"


By changing BVEAPI="N" to BVEAPI="Y", the BVEAPI service will start automatically.

[lwilson]

Thank you, that's all I needed to make this work!