Ask the Community
Groups
Example BVE API CLI Commands - Connect IT Community | Kaseya
<main> <article class="userContent"> <p><strong>Question: </strong>I would like to query using the BVE API. How can I go about this?</p> <p><strong>Resolution: </strong>Please see the following commands and adapt as necessary as per <a rel="nofollow" href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fhelp.kaseya.com%2FwebHelp%2FEN%2FTV%2F9050000%2FDEV%2F%2330146.htm">Client Commands</a></p> <p><strong>Export all devices by Status and export to csv (Run on the BVE):</strong></p> <p><TraverseHome>\utils>bveCLI.pl --host 127.0.0.1 --port 7661 --username superuser --password SUPERUSERPASSWORD --exec "device.status status=unknown" --format csv --output unknownDevices.csv</p> <p><strong>Export all devices by Status and export to txt (Run on the DGE or DGEx):</strong></p> <p><TraverseHome>\utils>bveCLI.pl --host BveIPAddress --port 7661 --username superuser --password SUPERUSERPASSWORD --exec "device.status status=unreachable"--output unreachableDevices.csv</p> <p><strong>List All Devices:</strong></p> <p>bveCLI.pl --host 10.20.30.32 --port 7661 --username superuser --password traverse --exec device.list devicename=*," --output AllDevices.txt</p> <p><strong>List All Tests:</strong></p> <p>bveCLI.pl --host 127.0.0.1 --username superuser --password traverse --exec "test.list deviceName=*" --output testListAll11.txt</p> <p><strong>List All WMI Tests, CSV format:</strong></p> <p>bveCLI.pl --host 127.0.0.1 --username superuser --password traverse --exec "test.list deviceName=*, testType=wmi" --output testListCSV.csv --format csv</p> <p><strong>Create SNMP System Uptime Test:</strong></p> <p><strong>(Test 'System Uptime_cli' gets created and shared credential is auto applied.)</strong></p> <p>bveCLI.pl --host 10.20.70.41 --user 195085 --pass xxxxx --exec "Test.create 'criticalthreshold=1800','devicename=IP_10.20.70.41_195085','resultmultiplier=1.0','resultprocessdirective=8','subtype=sys_uptime','testname=System Uptime_cli','testtype=snmp','warningthreshold=7200','maxvalue=0','snmpOId=.1.3.6.1.2.1.25.1.1.0'"</p> <p> </p> <p><strong>REFERENCES:</strong></p> <p><a rel="nofollow" href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/229045688">Connecting to the BVE API</a></p> <p><a rel="nofollow" href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fhelp.kaseya.com%2FwebHelp%2FEN%2FTV%2F9050000%2FDEV%2F%2330146.htm">Client Commands</a> - User Guide</p> <p><a rel="nofollow" href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/115002558911">BVE API: Escaping Special Characters</a></p> <p><a rel="nofollow" href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/229044528">Sample BVE API commands</a></p> <p><a rel="nofollow" href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/229042368">Tip: Create an Action Profile via the BVE API</a></p> <p><a rel="nofollow" href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/229042468">Tip: Enable test parameter rediscovery via the BVE API</a></p> <p><a rel="nofollow" href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/229044028">How to increase number of connections to BVE API (socket server)</a></p> <p> </p> </article> </main>