Metadata-Version: 1.1
Name: tcconfig
Version: 0.2.0
Summary: Simple tc command wrapper.
Easy to setup traffic control of
network bandwidth/latency/packet-loss to a network interface.

Home-page: https://github.com/thombashi/tcconfig
Author: Tsuyoshi Hombashi
Author-email: gogogo.vm@gmail.com
License: MIT License
Description: **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
        
        .. contents:: Table of contents
           :backlinks: top
           :local:
        
        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 <https://pip.pypa.io/en/stable/installing/>`__ (Python package
        manager).
        
        .. code:: console
        
            sudo pip install tcconfig
        
        Usage
        =====
        
        Set traffic control (tcset)
        ---------------------------
        
        tcset is a command to impose traffic control to a network interface
        (device).
        
        tcset help
        ~~~~~~~~~~
        
        .. code:: console
        
            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
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: console
        
            # tcset --device eth0 --rate 100k
        
        e.g. Set 100ms network delay
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. 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 onece
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. 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)
        ------------------------------
        
        tcdel is a command to delete traffic control from a network interface
        (device).
        
        tcdel help
        ~~~~~~~~~~
        
        .. code:: console
        
            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.
        ~~~~
        
        .. code:: console
        
            # tcdel --device eth0
        
        Dependencies
        ============
        
        Linux package
        -------------
        
        -  iproute2 (reqrequired for tc commandured)
        
        Python packagge
        ---------------
        
        -  `DataPropery <https://github.com/thombashi/DataProperty>`__
        -  `ipaddress <https://pypi.python.org/pypi/ipaddress>`__
        -  `thutils <https://github.com/thombashi/thutils>`__
        -  `six <https://pypi.python.org/pypi/six/>`__
        
        Python packagge: test dependencies
        ----------------------------------
        
        -  `pytest <https://pypi.python.org/pypi/pytest>`__
        -  `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
        -  `tox <https://pypi.python.org/pypi/tox>`__
        
Keywords: traffic control,bandwidth,latency,packet loss
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: System :: Networking
