RTA Manual |
|
Running RTA The RTA is designed to be run as a Windows Service and initiates Speed and VoIP tests on an interval basis as defined by the RTA.script file. The RTA can also be run from the command line without being installed as a service as indicated below. Command Line Syntax Options 1. Applying the license key (Not required for trial mode) mvsnocrta -license:< key > key : activate this license key (only required to be done on first use) Note: if you have purchased a license key you will need to apply the license key as a one-off event using the -license syntax. This is not necessary for trial mode. 2. Installing and uninstalling as a Windows service (recommended) mvsnocrta -install mcsnocrta -uninstall When running as a service you need to configure the rta.script text file to define the MyVoIPSpeed test requirements to set the interval , password, Session ID and the URL etc . Please review the example_rta.script (text) file for further documentation of the RTA script options. For your convenience this file can be copied to the file title rta.script. IMPORTANT NOTE : If you are running with a license key you must install the license key as per the instructions above before starting as a service. This is not necessary when running in trial mode however the service will fail when the trial period expires. 3. Running from the command line without installing as a Windows Service mvsnocrta -script Using the -service tag instructs the RTA agent to locate the rta.script file for processing unless another script file name is specified using the :<optional file name> syntax. This is useful for testing multiple script files for deployment or when using batch files for processing. Note when running as a Windows service only the file titled rta.script can be used as Windows services do not support command line options. Please review the example_rta.script (text) file for further documentation of script options. Script file is shown below. Note the script file has to be renamed to rta.script before it can be used. # The session ID is designed to allow the user to define an identifier sid=mytrial # The RTA will multi-thread and can therefore do more than one test at a time. allowsimultaneous=no # The prefix before '.' defines a title name for a specific thread test e.g 'voiptest1' voiptest1.url=myspeed.mydomain.com voiptest2.url=1.1.1.1 In the first section you can set a SID (session ID) for your speed test. This helps to identify the speed test in the records. In the second section you can choose whether to allow simultaneous tests or have the tests done one at a time. Simply set the 'allowsimultaneous=' parameter to no or yes accordingly. In the third section you define each test you wish to do. The parameters you can add for each test are explained below, and also in the the script file itself. - URL defines where the speed test is directed, domain name or IP address To install the RTA as a Windows service, from the dos command prompt at the RTA install directory type: mvsnocrta -install (installs as a windows service) Once installed the agent can be started by using the Windows Services Control Panel. The service name is 'Visualware MyVoIPSpeed NOC RTA Agent service' To uninstall the RTA as a Windows service, from the dos command prompt at the RTA install directory type: mvsnocrta -uninstall (uninstall's the Windows service) When running as a service you need to configure the rta_example.ini and save as rta.ini to set the interval , password, Session ID and the URL . IMPORTANT NOTE : If you are running with a license key you must install the license key as per the instructions in the run_rta_example.bat file before starting as a service. This is not necessary when running in trial mode however the service will fail when the trial period expires. Once the MyVoIPSpeed RTA has performed the speed test it then logs the results on the MyVoIPSpeed Server you designated in the command line.
The results will appear as they would do if you had performed the trace from the server applet. |
