A Simple tc command wrapper tool. Easy to set up traffic control of network bandwidth/latency/packet loss/packet-corruption to a network interface.
Project description
tcconfig
Summary
A Simple tc command wrapper tool. Easy to set up traffic control of network bandwidth/latency/packet loss/packet-corruption to a network interface.
Traffic control features
Traffic shaping target
Apply traffic shaping rules to specific targets:
Outgoing/Incoming packets
Source/Destination IP-address/network (IPv4/IPv6)
Source/Destination ports
Moreover, exclude from shaping rules from specific targets:
Source/Destination IP-address/network (IPv4/IPv6)
Source/Destination ports
Available parameters
The following parameters can set to network interfaces:
Network bandwidth rate [G/M/K bps]
Network latency [microseconds/milliseconds/seconds/minutes]
Packet loss rate [%]
Packet corruption rate [%]
Packet duplicate rate [%]
Packet reordering rate [%]
Usage
Set traffic control (tcset command)
tcset is a command to add traffic control rule to a network interface (device).
e.g. Set a limit on bandwidth up to 100Kbps
# tcset eth0 --rate 100Kbpse.g. Set network latency
You can use time units (such as us/sec/min/etc.) to designate delay time.
Set 100 milliseconds network latency
# tcset eth0 --delay 100msSet 10 seconds network latency
# tcset eth0 --delay 10secSet 0.5 minutes (30 seconds) network latency
# tcset eth0 --delay 0.5minYou can also use the following units:
m/min/mins/minute/minutes
s/sec/secs/second/seconds
ms/msec/msecs/millisecond/milliseconds
us/usec/usecs/microsecond/microseconds
e.g. Set 0.1% packet loss
# tcset eth0 --loss 0.1e.g. All of the above settings at once
# tcset eth0 --rate 100Kbps --delay 100ms --loss 0.1e.g. Specify the IP address of traffic control
# tcset eth0 --delay 100ms --network 192.168.0.10e.g. Specify the IP network and port of traffic control
# tcset eth0 --delay 100ms --network 192.168.0.0/24 --port 80Delete traffic control (tcdel command)
tcdel is a command to delete traffic shaping rules from a network interface (device).
e.g. Delete traffic control of eth0
You can delete all of the shaping rules for the eth0 with -a/--all option:
# tcdel eth0 --allDisplay traffic control configurations (tcshow command)
tcshow is a command to display the current traffic control settings for network interface(s).
Example
# tcset eth0 --delay 10 --delay-distro 2 --loss 0.01 --rate 0.25M --network 192.168.0.10 --port 8080
# tcset eth0 --delay 1 --loss 0.02 --rate 500K --direction incoming
# tcshow eth0
{
"eth0": {
"outgoing": {
"dst-network=192.168.0.10/32, dst-port=8080": {
"delay": "10.0",
"loss": "0.01",
"rate": "250K",
"delay-distro": "2.0"
},
"dst-network=0.0.0.0/0": {}
},
"incoming": {
"dst-network=0.0.0.0/0": {
"delay": "1.0",
"loss": "0.02",
"rate": "500K"
}
}
}
}For more information
More examples are available at https://tcconfig.rtfd.io/en/latest/pages/usage/index.html
Installation
Install via pip (recommended)
tcconfig can be installed from PyPI via pip (Python package manager) command.
sudo pip install tcconfigInstall in Debian/Ubuntu from a deb package
wget https://github.com/thombashi/tcconfig/releases/download/<version>/tcconfig_<version>_amd64.deb
dpkg -iv tcconfig_<version>_amd64.deb
- Example:
$ wget https://github.com/thombashi/tcconfig/releases/download/v0.19.0/tcconfig_0.19.0_amd64.deb $ sudo dpkg -i tcconfig_0.19.0_amd64.deb
Dependencies
Python 2.7+ or 3.4+
Linux packages
- mandatory: required for tc command:
Ubuntu/Debian: iproute2
Fedora/RHEL: iproute-tc
- optional: required to when you use --iptables option:
iptables
Linux kernel module
sch_netem
Python packages
Dependency python packages are automatically installed during tcconfig installation via pip.
Optional Python packages
- netifaces
Suppress excessive error messages if this package installed
Test dependencies
Documentation
Troubleshooting
https://tcconfig.rtfd.io/en/latest/pages/troubleshooting.html
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tcconfig-0.20.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e7d696a8d59a15eb650ec0a924417dae6186ca479d5321b67b26919bb3d6d543 |
|
| MD5 | f944912f3dbedad3ff6d8429d2489530 |
|
| BLAKE2b-256 | 62e6a2b5f95c16d184aa7dbe0627c293671bb3d807b9fcea7300d09cdf8d32c0 |
