QUESTION:
How to connect to the BVE API
RESOLUTION:
The BVE API allows you to access the provisioning database and real-time statistics over a TCP socket. You can connect to the BVE API through the PERL script located on the BVE server.
Requirements
- Make sure the BVE API component is running on the BVE server.
- Ther are no firewall or antivirus software rules that block TCP connections to port 7661.
To connect via PERL script
If you are logged into the BVE server or one of your DGEs or DGE extensions, you can submit commands to the BVE API. To do this, navigate to:
<Traverse_Installation_Directory>\utils
in the command prompt or terminal. Once there, run this command:
- <host> is the IP address of the BVE server. If you are on the BVE server, you can use localhost or 127.0.0.1.
- <username> and <password> is the username and password you are using to log into the BVE API. It is the same as the one used to log into the web app.
- <line to execute> is the command you are going to submit to the BVE API. Here, the whole command must be in double quotation marks and the search criteria must be in single quotation marks, so the example would be: "device.list 'deviceName=*', 'showLicenseCategory=true'"
- <output file> is the file you want to output the results to.
To query the BVE API without printing the output to a file and viewing the data directly in the command prompt or terminal interface. To do this, simply leave out the --output field.
You can also create a text file with all of the commands you want to run and submit them via the BVE CLI using the following command:
bveCLI.pl --host <host> --port 7661 --username <username> --password <password> --input <commandfile>.txt
- <commandfile>.txt is a text file with all of the commands you want to run. Make sure each command is in a new line and is in the format shown above. If the file is in a different location, make sure you include the full path.
To connect via Telnet
If you have telnet installed on your Windows or Linux server, you can also submit commands by to connect to the BVE API:
telnet n.n.n.n 7661
n.n.n.n denotes the IP address of the BVE server. If you are on the BVE server, then you can use localhost, or 127.0.0.1. 7661 is the BVE API port you will be connecting to.
You can also connect through the use of a network enabled terminal emulator, like PuTTY or AbsoluteTelnet, to complete the connection.
Once you are connected, use this command to login:
login <username> <password>
Use the credentials you would use to log into the web app.
When executing commands, put each search criteria in double quotation marks. For example:
device.list "deviceName=*", "showLicenseCategory=true"
For a full list of acceptable commands, please refer to this documentation http://help.kaseya.com/webhelp/EN/tv/R8/dev/index.asp#30146.htm.
APPLIES TO:
All versions of Traverse