Mininet Python API Reference Manual
Public Member Functions | Public Attributes | List of all members
mininet.nodelib.NAT Class Reference

NAT: Provides connectivity to external network. More...

Inheritance diagram for mininet.nodelib.NAT:
mininet.node.Node

Public Member Functions

def __init__ (self, name, subnet='10.0/8', localIntf=None, flush=False, **params)
 Start NAT/forwarding between Mininet and external network. More...
 
def setManualConfig (self, intf)
 Prevent network-manager/networkd from messing with our interface by specifying manual configuration in /etc/network/interfaces.
 
def config (self, **params)
 Configure the NAT and iptables.
 
def terminate (self)
 Stop NAT/forwarding between Mininet and external network.
 
- Public Member Functions inherited from mininet.node.Node
def __init__ (self, name, inNamespace=True, **params)
 
def fdToNode (cls, fd)
 Return node corresponding to given file descriptor. More...
 
def startShell (self, mnopts=None)
 Start a shell process for running commands.
 
def mountPrivateDirs (self)
 mount private directories
 
def unmountPrivateDirs (self)
 mount private directories
 
def cleanup (self)
 Help python collect its garbage.
 
def read (self, size=1024)
 Buffered read from node, potentially blocking. More...
 
def readline (self)
 Buffered readline from node, potentially blocking. More...
 
def write (self, data)
 Write data to node. More...
 
def stop (self, deleteIntfs=False)
 Stop node. More...
 
def waitReadable (self, timeoutms=None)
 Wait until node's output is readable. More...
 
def sendCmd (self, *args, **kwargs)
 Send a command, followed by a command to echo a sentinel, and return without waiting for the command to complete. More...
 
def sendInt (self, intr=chr(3))
 Interrupt running command.
 
def monitor (self, timeoutms=None, findPid=True)
 Monitor and return the output of a command. More...
 
def waitOutput (self, verbose=False, findPid=True)
 Wait for a command to complete. More...
 
def cmd (self, *args, **kwargs)
 Send a command, wait for output, and return it. More...
 
def cmdPrint (self, *args)
 Call cmd and printing its output. More...
 
def popen (self, *args, **kwargs)
 Return a Popen() object in our namespace. More...
 
def pexec (self, *args, **kwargs)
 Execute a command using popen. More...
 
def newPort (self)
 Return the next port number to allocate.
 
def addIntf (self, intf, port=None, moveIntfFn=moveIntf)
 Add an interface. More...
 
def delIntf (self, intf)
 Remove interface from Node's known interfaces. More...
 
def defaultIntf (self)
 Return interface for lowest port.
 
def intf (self, intf=None)
 Return our interface object with given string name, default intf if name is falsy (None, empty string, etc). More...
 
def connectionsTo (self, node)
 Return [ intf1, intf2... More...
 
def deleteIntfs (self, checkName=True)
 Delete all of our interfaces. More...
 
def setARP (self, ip, mac)
 Add an ARP entry. More...
 
def setHostRoute (self, ip, intf)
 Add route to host. More...
 
def setDefaultRoute (self, intf=None)
 Set the default route to go through intf. More...
 
def setMAC (self, mac, intf=None)
 Set the MAC address for an interface. More...
 
def setIP (self, ip, prefixLen=8, intf=None, **kwargs)
 Set the IP address for an interface. More...
 
def IP (self, intf=None)
 Return IP address of a node or specific interface.
 
def MAC (self, intf=None)
 Return MAC address of a node or specific interface.
 
def intfIsUp (self, intf=None)
 Check if an interface is up.
 
def setParam (self, results, method, **param)
 Internal. More...
 
def config (self, mac=None, ip=None, defaultRoute=None, lo='up', **_params)
 Configure Node according to (optional) More...
 
def configDefault (self, **moreParams)
 Configure with default parameters.
 
def linkTo (self, node, link=Link)
 (Deprecated) Link to another node replace with Link( node1, node2)
 
def intfList (self)
 List of our interfaces sorted by port number.
 
def intfNames (self)
 The names of our interfaces sorted by port number.
 
def __repr__ (self)
 More informative string representation.
 
def __str__ (self)
 Abbreviated string representation.
 
def checkSetup (cls)
 Make sure our class and superclasses are set up.
 
def setup (cls)
 Make sure our class dependencies are available.
 

Public Attributes

 subnet
 
 localIntf
 
 flush
 
 forwardState
 
- Public Attributes inherited from mininet.node.Node
 name
 
 privateDirs
 
 inNamespace
 
 waitExited
 
 params
 
 intfs
 
 ports
 
 nameToIntf
 
 waiting
 
 readbuf
 
 decoder
 
 slave
 
 shell
 
 stdin
 
 stdout
 
 pid
 
 pollOut
 
 execed
 
 lastCmd
 
 lastPid
 

Additional Inherited Members

- Static Public Attributes inherited from mininet.node.Node
int portBase = 0
 
dictionary inToNode = {}
 
dictionary outToNode = {}
 
bool isSetup = False
 

Detailed Description

NAT: Provides connectivity to external network.

Constructor & Destructor Documentation

◆ __init__()

def mininet.nodelib.NAT.__init__ (   self,
  name,
  subnet = '10.0/8',
  localIntf = None,
  flush = False,
**  params 
)

Start NAT/forwarding between Mininet and external network.

Parameters
subnetMininet subnet (default 10.0/8)
flushflush iptables before installing NAT rules

The documentation for this class was generated from the following file: