Home

The ringtools module offers a Python API to the NLNOG ring, making it easy to write code which performs commands on one or multiple nodes and for easier handling of output.

The ringtools-module consists of the following files:

• ringtools.exception providing the RingException class which is used for error signaling
• ringtools.node providing the RingNode and NodeCommandThread class which are used to interact with specific nodes
• ringtools.result providing the NodeResult and NodeResultSet class which are used to handle results from a node
• ringtools.ring providing functions for getting information about the ring and running commands on it

The examples directory in this repository contains various examples of increasing complexity showing the key features of the ring.