Pre-release
This release is a pre-release and may not be stable for production use.
tcconfig
========
.. image:: https://img.shields.io/pypi/pyversions/tcconfig.svg
:target: https://pypi.python.org/pypi/tcconfig
.. image:: https://travis-ci.org/thombashi/tcconfig.svg?branch=master
:target: https://travis-ci.org/thombashi/tcconfig
Summary
-------
``tcconfig`` is a Simple ``tc`` command wrapper.
Easy to set up traffic control of network bandwidth/latency/packet-loss to a network interface.
Traffic control features
------------------------
Network
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Traffic control can be specified network to apply to:
- Outgoing/Incoming packets
- Certain IP address/network and port
Available parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following parameters can be set to network interfaces.
- Network bandwidth rate [G/M/K bps]
- Network latency [milliseconds]
- Packet loss rate [%]
- Packet corruption rate [%]
.. image:: docs/gif/tcset_example.gif
Usage
=====
Set traffic control (``tcset`` command)
---------------------------------------
``tcset`` is a command to impose traffic control to a network interface (device).
e.g. Set a limit on bandwidth up to 100Kbps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --rate 100k
e.g. Set 100ms network latency
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --delay 100
e.g. Set 0.1% packet loss
^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --loss 0.1
e.g. All of the above at once
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --rate 100k --delay 100 --loss 0.1
e.g. Specify the IP address of traffic control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --delay 100 --network 192.168.0.10
e.g. Specify the IP network and port of traffic control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --delay 100 --network 192.168.0.0/24 --port 80
Delete traffic control (``tcdel`` command)
------------------------------------------
``tcdel`` is a command to delete traffic control from a network
interface (device).
e.g. Delete traffic control of eth0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcdel --device eth0
Display traffic control configurations (``tcshow`` command)
-----------------------------------------------------------
``tcshow`` is a command to display traffic control to network interface(s).
Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# 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": {
"network=192.168.0.10/32, port=8080": {
"delay": "10.0",
"loss": "0.01",
"rate": "250K",
"delay-distro": "2.0"
},
"network=0.0.0.0/0": {}
},
"incoming": {
"network=0.0.0.0/0": {
"delay": "1.0",
"loss": "0.02",
"rate": "500K"
}
}
}
}
For more information
--------------------
More examples are available at
http://tcconfig.readthedocs.org/en/latest/pages/usage/index.html
Installation
============
Install via pip
---------------
``tcconfig`` can be installed via
`pip <https://pip.pypa.io/en/stable/installing/>`__ (Python package manager).
.. code:: console
sudo pip install tcconfig
Dependencies
============
Linux packages
--------------
- iproute2 (required for tc command)
Linux kernel module
----------------------------
- sch_netem
Python packages
---------------
Dependency python packages are automatically installed during
``tcconfig`` installation via pip.
- `DataPropery <https://github.com/thombashi/DataProperty>`__
- `ipaddress <https://pypi.python.org/pypi/ipaddress>`__
- `logbook <http://logbook.readthedocs.io/en/stable/>`__
- `pyparsing <https://pyparsing.wikispaces.com/>`__
- `six <https://pypi.python.org/pypi/six/>`__
- `subprocrunner <https://github.com/thombashi/subprocrunner>`__
- `voluptuous <https://github.com/alecthomas/voluptuous>`__
Optional
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- `netifaces <https://bitbucket.org/al45tair/netifaces>`__
- Suppress excessive error messages if this package is installed
Test dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- `pingparsing <https://github.com/thombashi/pingparsing>`__
- `pytest <http://pytest.org/latest/>`__
- `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
- `tox <https://testrun.org/tox/latest/>`__
Documentation
=============
http://tcconfig.readthedocs.org/en/latest/
Troubleshooting
========================
Phenomenon
------------------------
`tcset` command failed with an error message `RTNETLINK answers: No such file or directory`.
Cause and counter measures
------------------------
The cause of this error is `sch_netem` kernel module is not loaded in your system.
Execute the following command to solve this problem:
.. code:: console
# modprobe sch_netem
The command is loading the `sch_netem` module.
If the command failed with below message, you need to install additional kernel module.
.. code:: console
# modprobe: FATAL: Module sch_netem not found in directory /lib/modules/xxxxxx
Execute the following command to install kernel modules (includes the `sch_netem` module).
.. code:: console
# dnf install kernel-modules-extra
(in the case of `RHEL`/`CentOS`/`Fedora`).
After that, re-execute `modprobe sch_netem` command.
.. code:: console
# modprobe sch_netem
#
========
.. image:: https://img.shields.io/pypi/pyversions/tcconfig.svg
:target: https://pypi.python.org/pypi/tcconfig
.. image:: https://travis-ci.org/thombashi/tcconfig.svg?branch=master
:target: https://travis-ci.org/thombashi/tcconfig
Summary
-------
``tcconfig`` is a Simple ``tc`` command wrapper.
Easy to set up traffic control of network bandwidth/latency/packet-loss to a network interface.
Traffic control features
------------------------
Network
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Traffic control can be specified network to apply to:
- Outgoing/Incoming packets
- Certain IP address/network and port
Available parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following parameters can be set to network interfaces.
- Network bandwidth rate [G/M/K bps]
- Network latency [milliseconds]
- Packet loss rate [%]
- Packet corruption rate [%]
.. image:: docs/gif/tcset_example.gif
Usage
=====
Set traffic control (``tcset`` command)
---------------------------------------
``tcset`` is a command to impose traffic control to a network interface (device).
e.g. Set a limit on bandwidth up to 100Kbps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --rate 100k
e.g. Set 100ms network latency
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --delay 100
e.g. Set 0.1% packet loss
^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --loss 0.1
e.g. All of the above at once
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --rate 100k --delay 100 --loss 0.1
e.g. Specify the IP address of traffic control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --delay 100 --network 192.168.0.10
e.g. Specify the IP network and port of traffic control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcset --device eth0 --delay 100 --network 192.168.0.0/24 --port 80
Delete traffic control (``tcdel`` command)
------------------------------------------
``tcdel`` is a command to delete traffic control from a network
interface (device).
e.g. Delete traffic control of eth0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# tcdel --device eth0
Display traffic control configurations (``tcshow`` command)
-----------------------------------------------------------
``tcshow`` is a command to display traffic control to network interface(s).
Example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: console
# 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": {
"network=192.168.0.10/32, port=8080": {
"delay": "10.0",
"loss": "0.01",
"rate": "250K",
"delay-distro": "2.0"
},
"network=0.0.0.0/0": {}
},
"incoming": {
"network=0.0.0.0/0": {
"delay": "1.0",
"loss": "0.02",
"rate": "500K"
}
}
}
}
For more information
--------------------
More examples are available at
http://tcconfig.readthedocs.org/en/latest/pages/usage/index.html
Installation
============
Install via pip
---------------
``tcconfig`` can be installed via
`pip <https://pip.pypa.io/en/stable/installing/>`__ (Python package manager).
.. code:: console
sudo pip install tcconfig
Dependencies
============
Linux packages
--------------
- iproute2 (required for tc command)
Linux kernel module
----------------------------
- sch_netem
Python packages
---------------
Dependency python packages are automatically installed during
``tcconfig`` installation via pip.
- `DataPropery <https://github.com/thombashi/DataProperty>`__
- `ipaddress <https://pypi.python.org/pypi/ipaddress>`__
- `logbook <http://logbook.readthedocs.io/en/stable/>`__
- `pyparsing <https://pyparsing.wikispaces.com/>`__
- `six <https://pypi.python.org/pypi/six/>`__
- `subprocrunner <https://github.com/thombashi/subprocrunner>`__
- `voluptuous <https://github.com/alecthomas/voluptuous>`__
Optional
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- `netifaces <https://bitbucket.org/al45tair/netifaces>`__
- Suppress excessive error messages if this package is installed
Test dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- `pingparsing <https://github.com/thombashi/pingparsing>`__
- `pytest <http://pytest.org/latest/>`__
- `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
- `tox <https://testrun.org/tox/latest/>`__
Documentation
=============
http://tcconfig.readthedocs.org/en/latest/
Troubleshooting
========================
Phenomenon
------------------------
`tcset` command failed with an error message `RTNETLINK answers: No such file or directory`.
Cause and counter measures
------------------------
The cause of this error is `sch_netem` kernel module is not loaded in your system.
Execute the following command to solve this problem:
.. code:: console
# modprobe sch_netem
The command is loading the `sch_netem` module.
If the command failed with below message, you need to install additional kernel module.
.. code:: console
# modprobe: FATAL: Module sch_netem not found in directory /lib/modules/xxxxxx
Execute the following command to install kernel modules (includes the `sch_netem` module).
.. code:: console
# dnf install kernel-modules-extra
(in the case of `RHEL`/`CentOS`/`Fedora`).
After that, re-execute `modprobe sch_netem` command.
.. code:: console
# modprobe sch_netem
#
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tcconfig-0.7.0a1.tar.gz
(23.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tcconfig-0.7.0a1.tar.gz.
File metadata
- Download URL: tcconfig-0.7.0a1.tar.gz
- Upload date:
- Size: 23.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d2f88b6caf0abad585ab9a56e41b17ef2557ab946506f49979428a1d62cb0f4b
|
|
| MD5 |
d710df6c0eefa188476d27ffb15f4c68
|
|
| BLAKE2b-256 |
1caf194d0decc1592c3e97a5d1496d372ef259df5e24a41467f3e29c80712d0b
|
File details
Details for the file tcconfig-0.7.0a1-py2.py3-none-any.whl.
File metadata
- Download URL: tcconfig-0.7.0a1-py2.py3-none-any.whl
- Upload date:
- Size: 22.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f11dec1bcf8d40c8af7026dff7eb6d5f485a455e20c79d3838f88e7a278d252f
|
|
| MD5 |
62f9043433d95014b9249414221c0577
|
|
| BLAKE2b-256 |
1b22e1a799cc19d927cf534c3628ca84d233904fe52ca7f96eaf3ec09f6cc48e
|
