tcconfig 0.2.0

Simple tc command wrapper. Easy to setup traffic control of network bandwidth/latency/packet-loss to a network interface.

tcconfig

Table of contents

• Summary

• Traffic control

• Installation

• Usage

  • Set traffic control (tcset)

    • tcset help

    • e.g. Set a limit on bandwidth up to 100Kbps

    • e.g. Set 100ms network delay

    • e.g. Set 0.1% packet loss

    • e.g. All of the above at onece

    • e.g. Specify the IP address of traffic control

    • e.g. Specify the IP network and port of traffic control

  • Delete traffic control (tcdel)

    • tcdel help

    • e.g.

• Dependencies

  • Linux package

  • Python packagge

  • Python packagge: test dependencies

Summary

Simple tc command wrapper. Easy to setup traffic control of network bandwidth/latency/packet-loss to a network interface.

Traffic control

The following parameters can be set of network interfaces.

• Network bandwidth [G/M/K bps]

• Network latency [milliseconds]

• Packet loss rate [%]

Traffic control can specify the IP network and port to apply to.

Installation

Install via pip

tcconfig canbe installed via pip (Python package manager).

sudo pip install tcconfig

Usage

Set traffic control (tcset)

tcset is a command to impose traffic control to a network interface (device).

tcset help

usage: tcset [-h] [--version] [--logging] [--stacktrace] [--debug | --quiet]
             --device DEVICE [--rate RATE] [--delay DELAY] [--loss LOSS]
             [--network NETWORK] [--port PORT] [--overwrite]

optional arguments:
  -h, --help         show this help message and exit
  --version          show program's version number and exit
  --debug            for debug print.
  --quiet            suppress output of execution log message.

Miscellaneous:
  --logging          output execution log to a file (tcset.log).
  --stacktrace       display stack trace when an error occurred.

Traffic Control:
  --device DEVICE    network device name
  --rate RATE        network bandwidth to apply the limit [K|M|G bps]
  --delay DELAY      round trip network delay [ms] (default=0)
  --loss LOSS        round trip packet loss rate [%] (default=0)
  --network NETWORK  destination network of traffic control
  --port PORT        destination port of traffic control
  --overwrite        overwrite existing setting

e.g. Set a limit on bandwidth up to 100Kbps

# tcset --device eth0 --rate 100k

e.g. Set 100ms network delay

# tcset --device eth0 --delay 100

e.g. Set 0.1% packet loss

# tcset --device eth0 --loss 0.1

e.g. All of the above at onece

# tcset --device eth0 --rate 100k --delay 100 --loss 0.1

e.g. Specify the IP address of traffic control

# tcset --device eth0 --delay 100 --network 192.168.0.10

e.g. Specify the IP network and port of traffic control

# tcset --device eth0 --delay 100 --network 192.168.0.0/24 --port 80

Delete traffic control (tcdel)

tcdel is a command to delete traffic control from a network interface (device).

tcdel help

usage: tcdel [-h] [--version] [--logging] [--stacktrace] [--debug | --quiet]
             --device DEVICE

optional arguments:
  -h, --help       show this help message and exit
  --version        show program's version number and exit
  --debug          for debug print.
  --quiet          suppress output of execution log message.

Miscellaneous:
  --logging        output execution log to a file (tcdel.log).
  --stacktrace     display stack trace when an error occurred.

Traffic Control:
  --device DEVICE  network device name

e.g.

# tcdel --device eth0

Dependencies

Linux package

• iproute2 (reqrequired for tc commandured)

Python packagge

• DataPropery

• ipaddress

• thutils

• six

Python packagge: test dependencies

• pytest

• pytest-runner

• tox