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 --device eth0 --rate 100ke.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 --device eth0 --delay 100msSet 10 seconds network latency
# tcset --device eth0 --delay 10secSet 0.5 minutes (30 seconds) network latency
# tcset --device eth0 --delay 0.5mine.g. Set 0.1% packet loss
# tcset --device eth0 --loss 0.1e.g. All of the above at once
# tcset --device eth0 --rate 100k --delay 100 --loss 0.1e.g. Specify the IP address of traffic control
# tcset --device eth0 --delay 100 --network 192.168.0.10e.g. Specify the IP network and port of traffic control
# tcset --device eth0 --delay 100 --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 --device eth0 --allDisplay traffic control configurations (tcshow command)
tcshow is a command to display the current traffic control settings for network interface(s).
Example
# tcset --device eth0 --delay 10 --delay-distro 2 --loss 0.01 --rate 0.25M --network 192.168.0.10 --port 8080
# tcset --device eth0 --delay 1 --loss 0.02 --rate 500K --direction incoming
# tcshow --device 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 http://tcconfig.rtfd.io/en/latest/pages/usage/index.html Installation ============
Installing from PyPI
tcconfig can be installed from PyPI via pip (Python package manager) command.
sudo pip install tcconfigInstalling from files
The following package includes tcconfig and dependency packages. This package is for environments which cannot access to PyPI directly.
How to install:
Navigate to https://github.com/thombashi/tcconfig/releases/
Download the latest version of tcconfig_wheel.tar.gz
Copy tcconfig_wheel.tar.gz to installation target
tar xvf tcconfig_wheel.tar.gz
cd tcconfig_wheel/
./install.sh
Dependencies
Linux packages
iproute/iproute2/iproute-tc (mandatory: required for tc command)
iptables (optional: required to when you use --iptables option)
Linux kernel module
sch_netem
Python packages
Dependency python packages are automatically installed during tcconfig installation via pip.
Optional
- netifaces
Suppress excessive error messages if this package installed
Test dependencies
Documentation
Troubleshooting
http://tcconfig.readthedocs.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.16.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c9e072918ffeb1526902cd1901956e63f8964079bcded18f60660dce3ad42115 |
|
| MD5 | e7ef46ca482ea332f91ca89d99f9e68a |
|
| BLAKE2b-256 | 00e46308f02a4f1de064733833b6d3b3c08544bdd802ef14cb4dcb17abcf9395 |
