Ask the Community
Groups
Sample BVE API commands - Connect IT Community | Kaseya
<main> <article class="userContent"> <p><strong>QUESTION:</strong></p> <p>What are some example BVE API commands?</p> <p> </p> <p><strong>RESOLUTION:</strong></p> <p>These commands may be invoked by a member of the 'superusers' group:</p> <p>#create a new user class<br>userclass.create "className=First Class", "comment=The way to travel"</p> <p># create a new department<br>department.create "departmentName=acme", "className=First Class", "contactEmail=support@kaseya.com", "contactPhone=888.888.8888", "password=traverse", "passwordVerify=traverse"</p> <p># create 2 new dge extensions<br>dgex.create "dgexName=del-dgex01", "upstreamDgeName=dge-1", "upstreamDgeAddress=10.10.14.159", "description=sanjose", "softLimit=4800", "hardLimit=5000"<br>dgex.create "dgexName=del-dgex02", "upstreamDgeName=dge-1", "upstreamDgeAddress=10.10.14.159", "description=sanjose", "softLimit=4800", "hardLimit=5000"</p> <p># create devices in new department monitored by first dge extension<br>device.create "devicename=rtr01", "address=10.10.15.253", "devicetype=router", "locationName=del-dgex01:sanjose", "username=acme"<br>device.create "devicename=rtr02", "address=10.10.15.253", "devicetype=router", "locationName=del-dgex01:sanjose", "username=acme"<br>device.create "devicename=rtr03", "address=10.10.15.253", "devicetype=router", "locationName=del-dgex01:sanjose", "username=acme"<br>device.create "devicename=rtr04", "address=10.10.15.253", "devicetype=router", "locationName=del-dgex01:sanjose", "username=acme"<br>device.create "devicename=rtr05", "address=10.10.15.253", "devicetype=router", "locationName=del-dgex01:sanjose", "username=acme"</p> <p># Create ping tests on new devices<br>test.create "criticalthreshold=100", "devicename=rtr01", "interval=180", "subtype=pl", "testname=Packet Loss", "testtype=ping", "units=%", "warningthreshold=60", "userName=acme"<br>test.create "criticalthreshold=1500", "devicename=rtr01", "interval=180", "subtype=rtt", "testname=Round Trip Time", "testtype=ping", "units=ms", "warningthreshold=250", "userName=acme"<br>test.create "criticalthreshold=100", "devicename=rtr02", "interval=180", "subtype=pl", "testname=Packet Loss", "testtype=ping", "units=%", "warningthreshold=60", "userName=acme"<br>test.create "criticalthreshold=1500", "devicename=rtr02", "interval=180", "subtype=rtt", "testname=Round Trip Time", "testtype=ping", "units=ms", "warningthreshold=250", "userName=acme"<br>test.create "criticalthreshold=100", "devicename=rtr03", "interval=180", "subtype=pl", "testname=Packet Loss", "testtype=ping", "units=%", "warningthreshold=60", "userName=acme"<br>test.create "criticalthreshold=1500", "devicename=rtr03", "interval=180", "subtype=rtt", "testname=Round Trip Time", "testtype=ping", "units=ms", "warningthreshold=250", "userName=acme"<br>test.create "criticalthreshold=100", "devicename=rtr04", "interval=180", "subtype=pl", "testname=Packet Loss", "testtype=ping", "units=%", "warningthreshold=60", "userName=acme"<br>test.create "criticalthreshold=1500", "devicename=rtr04", "interval=180", "subtype=rtt", "testname=Round Trip Time", "testtype=ping", "units=ms", "warningthreshold=250", "userName=acme"<br>test.create "criticalthreshold=100", "devicename=rtr05", "interval=180", "subtype=pl", "testname=Packet Loss", "testtype=ping", "units=%", "warningthreshold=60", "userName=acme"<br>test.create "criticalthreshold=1500", "devicename=rtr05", "interval=180", "subtype=rtt", "testname=Round Trip Time", "testtype=ping", "units=ms", "warningthreshold=250", "userName=acme"</p> <p> </p> <p> #Create a WMI System Uptime test<br>test.create "testName=System Uptime", "testType=wmi", "subType=sys_uptime", "deviceName=Traverse Server", "loginName=.\\Administrator", "interval=600", "warningThreshold=7200", "criticalThreshold=1800", "units=", "actionName=None", "thresholdType=descend", "resultProcessDirective=8", "resultMultiplier=100.0", "maxValue=0" ,"wmiProperty=\\Win32_PerfFormattedData_PerfOS_System:SystemUpTime:<a href="https://kaseya.vanillacommunities.com/profile/%2C%20" rel="nofollow">@, </a>username=traverse"<br><br></p> <p><strong>APPLIES TO:</strong></p> <p>All versions of Traverse </p> <p> </p> <p><strong>REFERENCE:</strong></p> <p>None</p> <p> </p> </article> </main>