- Clone the repository to a known folder, e.g. in
c:\malaga-platform - Enter the folder
cd c:/malaga-platform/iPerfAgent- Create a new Python virtualenv:
pip install virtualenv
virtualenv venv- Activate the virtual environment:
- For Windows:
venv\Scripts\Activate.bat- For Linux:
source venv/bin/activate- Install Python dependencies:
pip install -r requirements.txt- Start the development server:
flask runThe app will start listening for requests on port 5000.
Press Control+C to stop the development server.
The iPerfAgent instance can be configured by editing the config.yml file.
The value that can be configured on config.yml is:
- IPERF_PATH: Location of iPerf executable
The iPerf Agent exposes a REST API with the following endpoints:
/Iperf(POST): Executes iPerf process with the specific parameters in the request body in JSON format. Returns a JSON reporting the success of the execution and a message./Iperf/<pathParameters>: Executes iPerf process with the specific parameters. Returns a JSON reporting the success of the command execution and a message./Close: Closes iPerf process. Returns a JSON reporting the success of the process closure and a message./LastRawResult: Retrieve the results of the previous execution. Returns a JSON reporting the success of the retrieval, a message and a list of Results (full line)./LastJsonResult: Retrieve the results of the previous execution. Returns a JSON reporting the success of the retrieval, a message and a list of Results (dictionary with parsed results)./LastError: Retrieve the errors of the last execution. Returns a JSON reporting the success of the retrieval and a message informing of the error./StartDateTime: Retrieve the date and time of the last execution. Returns a JSON reporting the success of the retrieval, a message and a list of Errors./IsRunning: Check if there is another execution running. Returns a JSON reporting the success of the check and a message informing if is running or not.
- Gonzalo Chica Morales
- Bruno Garcia Garcia
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.