python-openflow(1)

NAME
python-openflow - low level library to parse OpenFlow messages

DESCRIPTION
python-openflow is a low level library to parse OpenFlow messages. If you want to read an OpenFlow packet from an open socket or send a message to an OpenFlow switch, this is your best friend. The main features are: high performance, latest specification compliance, short learning curve and free software license.

This library is part of Kytos project, a collaborative project between SPRACE (from São Paulo State University, Unesp) and Caltech (California Institute of Technology). python-openflow was developed to be used with Kytos controller, but feel free to use this simple and intuitive library in another project with another controller.

OVERVIEW

This is just an overview for you to check whether this project fits your needs. For a more detailed documentation, please check the python-openflow API Reference Manual at http://docs.kytos.io/python-openflow.

USAGE
For example, see how it is easy to create a feature request message with this library. You can use ipython3 to get the advantages of autocompletion:

    >>> from pyof.v0x01.controller2switch.features_request import FeaturesRequest
    >>> request = FeaturesRequest(xid = 100)
    >>> print(request.header.message_type)
    Type.OFPT_FEATURES_REQUEST
    >>> print(request.header.xid)
    100

If you need to send this message via socket, call the pack() method to get its binary representation:

    >>> binary_msg = request.pack()

SUPPORT
We are available in IRC and there is also a development mailing list. Details are available in the full documentation.

CONTRIBUTING
Contributions are welcome either by creating issues in GitHub or in the form of pull requests. Before, please, read the contribution and hacking guides in the main documentation.

AUTHOR
The python-openflow was written by Kytos Development Team <devel@lists.kytos.io>.

This manual page was written by Paulo Henrique de Lima Santana (phls) <phls@softwarelivre.org> for the Debian project (but may be used by others).