FAQ and Knowledge Base

Main Page > Browse Categories > VVEngine > 27. Monitoring Multiple VVEngine Installations via the REST API and JSON

27. Monitoring Multiple VVEngine Installations via the REST API and JSON

Starting with version 2.2, Build 2230, VVEngine now supports querying the status of its scheduled profiles via a REST API. The returned information is formatted as JSON objects.

The status of the profiles can be queried at URLs /profiles/ and/or /profiles/status/.

This is useful for remote monitoring of multiple VVEngine installations running on the network, using server monitoring software and/or network sensors.

It is recommended that you use the new VVEngine REST API and its JSON returned objects to monitor multiple VVEngine remotely.

Here is an example of a query via HTTP:
http://10.10.0.1:8001/profiles/

returning JSON:
{
  "profiles":[
     {
        "_list":"http:\/\/10.10.0.1:8001\/profiles\/",
        "_self":"http:\/\/10.10.0.1:8001\/profiles\/copyattr.fsf\/",
        "category":"Unfiled",
        "current_time":"Wed, 29 Jul 2020 07:39:44 GMT",
        "description":"",
        "last_exit_code":13,
        "last_run":"Error - 7\/27\/2020 2:55:27 PM until 2:55:30 PM (3 sec) - (Manual Run) - Source folder not found.",
        "last_successsful_run":"None",
        "name":"copyattrtest.fsf",
        "next_run":"None",
        "path":"C:\\ViceVersa PRO\\copyattr.fsf",
        "schedule":"Run manually",
        "status":"Disabled",
        "status_details":"",
        "status_has_any_errors":false,
        "status_has_any_errors_or_disabled":true,
        "status_is_active":false,
        "status_is_disabled":true,
        "status_is_error":false,
        "status_is_exec_error":false,
        "status_is_not_avail":false,
        "status_is_pending":false,
        "status_is_running":false,
        "url":"http:\/\/ 10.10.0.1:8001\/profile.htm?SHOWPROFILE=C%3a%5c%5c%5ccopyattr%2efsf",
        "url_summary_status_json":"http:\/\/ 10.10.0.1:8001\/profiles\/status\/" 
     }
   ]
}

or
http://198.152.1.10:8001/profiles/status/have_any_errors_or_disabled/

returning:
{"have_any_errors_or_disabled":0}

If this exact string is not returned {"have_any_errors_or_disabled":0} then VVEngine is down or there are some profiles that have errors or are disabled.

Full description of the VVEngine REST API is available in the VVEngine manual.

To allow access to the VVEngine REST API from a remote computer, make sure you allow remote connections to VVEngine in the VVEngine settings, and also make sure that HTTP traffic on the port where VVEngine is running is allowed through the network firewall. Can I Connect to VVEngine from a Remote Computer?



User Comments
Add Comment
There are no user comments for this topic.
Add Comment
Attachments
No attachments

Did this help you?
Yes No

Statistics
44% found this information useful

Other Options
Printable Version

General Information
No. 140
Author: TGRMN Software

Download ViceVersa


Visit ViceVersa Forum
  
  
 A printable version of the entire ViceVersa FAQ and Knowledge Base is also available.

 For further queries, please contact us by E-Mail at support@tgrmn.com.