afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: updates to cleanup formatting on tables and denote that the python gui is the default in index.md

Browse source
This commit is contained in:
Blake Harnden 2022-02-25 10:38:14 -08:00
parent a7588a2188
commit 482ad037f4
9 changed files with 310 additions and 310 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/configservices.md
View file

@ -28,23 +28,23 @@ will allow quickly dragging and dropping that node type during creation.
## Available Services ## Available Services
| Service Group | Services | | Service Group | Services |
|---|---| |----------------------------------|-----------------------------------------------------------------------|
|[BIRD](services/bird.md)|BGP, OSPF, RADV, RIP, Static| | [BIRD](services/bird.md) | BGP, OSPF, RADV, RIP, Static |
|[EMANE](services/emane.md)|Transport Service| | [EMANE](services/emane.md) | Transport Service |
|[FRR](services/frr.md)|BABEL, BGP, OSPFv2, OSPFv3, PIMD, RIP, RIPNG, Zebra| | [FRR](services/frr.md) | BABEL, BGP, OSPFv2, OSPFv3, PIMD, RIP, RIPNG, Zebra |
|[NRL](services/nrl.md)|arouted, MGEN Sink, MGEN Actor, NHDP, OLSR, OLSRORG, OLSRv2, SMF| | [NRL](services/nrl.md) | arouted, MGEN Sink, MGEN Actor, NHDP, OLSR, OLSRORG, OLSRv2, SMF |
|[Quagga](services/quagga.md)|BABEL, BGP, OSPFv2, OSPFv3, OSPFv3 MDR, RIP, RIPNG, XPIMD, Zebra| | [Quagga](services/quagga.md) | BABEL, BGP, OSPFv2, OSPFv3, OSPFv3 MDR, RIP, RIPNG, XPIMD, Zebra |
|[SDN](services/sdn.md)|OVS, RYU| | [SDN](services/sdn.md) | OVS, RYU |
|[Security](services/security.md)|Firewall, IPsec, NAT, VPN Client, VPN Server| | [Security](services/security.md) | Firewall, IPsec, NAT, VPN Client, VPN Server |
|[Utility](services/utility.md)|ATD, Routing Utils, DHCP, FTP, IP Forward, PCAP, RADVD, SSF, UCARP| | [Utility](services/utility.md) | ATD, Routing Utils, DHCP, FTP, IP Forward, PCAP, RADVD, SSF, UCARP |
|[XORP](services/xorp.md)|BGP, OLSR, OSPFv2, OSPFv3, PIMSM4, PIMSM6, RIP, RIPNG, Router Manager| | [XORP](services/xorp.md) | BGP, OLSR, OSPFv2, OSPFv3, PIMSM4, PIMSM6, RIP, RIPNG, Router Manager |
## Node Types and Default Services ## Node Types and Default Services
Here are the default node types and their services: Here are the default node types and their services:
| Node Type | Services | | Node Type | Services |
|---|---| |-----------|--------------------------------------------------------------------------------------------------------------------------------------------|
| *router* | zebra, OSFPv2, OSPFv3, and IPForward services for IGP link-state routing. | | *router* | zebra, OSFPv2, OSPFv3, and IPForward services for IGP link-state routing. |
| *PC* | DefaultRoute service for having a default route when connected directly to a router. | | *PC* | DefaultRoute service for having a default route when connected directly to a router. |
| *mdr* | zebra, OSPFv3MDR, and IPForward services for wireless-optimized MANET Designated Router routing. | | *mdr* | zebra, OSPFv3MDR, and IPForward services for wireless-optimized MANET Designated Router routing. |

12
docs/devguide.md
View file

@ -10,12 +10,12 @@ historical reasons. Current development focuses on the Python modules and
daemon. Here is a brief description of the source directories. daemon. Here is a brief description of the source directories.
| Directory | Description | | Directory | Description |
|---|---| |-----------|--------------------------------------------------------------------------------------|
|daemon|Python CORE daemon code that handles receiving API calls and creating containers| | daemon | Python CORE daemon/gui code that handles receiving API calls and creating containers |
|docs|Markdown Documentation currently hosted on GitHub| | docs | Markdown Documentation currently hosted on GitHub |
|gui|Tcl/Tk GUI| | gui | Tcl/Tk GUI |
|man|Template files for creating man pages for various CORE command line utilities| | man | Template files for creating man pages for various CORE command line utilities |
|netns|C program for creating CORE containers| | netns | C program for creating CORE containers |
## Getting started ## Getting started

14
docs/emane.md
View file

@ -62,13 +62,13 @@ Every topic below assumes CORE, EMANE, and OSPF MDR have been installed.
> **WARNING:** demo files will be found within the new `core-pygui` > **WARNING:** demo files will be found within the new `core-pygui`
|Topic|Model|Description| | Topic | Model | Description |
|---|---|---| |--------------------------------------|---------|-----------------------------------------------------------|
|[XML Files](emane/files.md)|RF Pipe|Overview of generated XML files used to drive EMANE| | [XML Files](emane/files.md) | RF Pipe | Overview of generated XML files used to drive EMANE |
|[GPSD](emane/gpsd.md)|RF Pipe|Overview of running and integrating gpsd with EMANE| | [GPSD](emane/gpsd.md) | RF Pipe | Overview of running and integrating gpsd with EMANE |
|[Precomputed](emane/precomputed.md)|RF Pipe|Overview of using the precomputed propagation model| | [Precomputed](emane/precomputed.md) | RF Pipe | Overview of using the precomputed propagation model |
|[EEL](emane/eel.md)|RF Pipe|Overview of using the Emulation Event Log (EEL) Generator| | [EEL](emane/eel.md) | RF Pipe | Overview of using the Emulation Event Log (EEL) Generator |
|[Antenna Profiles](emane/antenna.md)|RF Pipe|Overview of using antenna profiles in EMANE| | [Antenna Profiles](emane/antenna.md) | RF Pipe | Overview of using antenna profiles in EMANE |
## EMANE Configuration ## EMANE Configuration

44
docs/gui.md
View file

@ -94,7 +94,7 @@ item, starting from the top. Most of the tools are grouped into related
sub-menus, which appear when you click on their group icon. sub-menus, which appear when you click on their group icon.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |----------------------------|----------------|----------------------------------------------------------------------------------------|
| ![](static/gui/select.gif) | Selection Tool | Tool for selecting, moving, configuring nodes. | | ![](static/gui/select.gif) | Selection Tool | Tool for selecting, moving, configuring nodes. |
| ![](static/gui/start.gif) | Start Button | Starts Execute mode, instantiates the emulation. | | ![](static/gui/start.gif) | Start Button | Starts Execute mode, instantiates the emulation. |
| ![](static/gui/link.gif) | Link | Allows network links to be drawn between two nodes by clicking and dragging the mouse. | | ![](static/gui/link.gif) | Link | Allows network links to be drawn between two nodes by clicking and dragging the mouse. |
@ -104,7 +104,7 @@ sub-menus, which appear when you click on their group icon.
These nodes will create a new node container and run associated services. These nodes will create a new node container and run associated services.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |-----------------------------------------|---------|------------------------------------------------------------------------------|
| ![](static/gui/router.gif) | Router | Runs Quagga OSPFv2 and OSPFv3 routing to forward packets. | | ![](static/gui/router.gif) | Router | Runs Quagga OSPFv2 and OSPFv3 routing to forward packets. |
| ![](static/gui/host.gif) | Host | Emulated server machine having a default route, runs SSH server. | | ![](static/gui/host.gif) | Host | Emulated server machine having a default route, runs SSH server. |
| ![](static/gui/pc.gif) | PC | Basic emulated machine having a default route, runs no processes by default. | | ![](static/gui/pc.gif) | PC | Basic emulated machine having a default route, runs no processes by default. |
@ -118,7 +118,7 @@ These nodes are mostly used to create a Linux bridge that serves the
purpose described below. purpose described below.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |-------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![](static/gui/hub.gif) | Hub | Ethernet hub forwards incoming packets to every connected node. | | ![](static/gui/hub.gif) | Hub | Ethernet hub forwards incoming packets to every connected node. |
| ![](static/gui/lanswitch.gif) | Switch | Ethernet switch intelligently forwards incoming packets to attached hosts using an Ethernet address hash table. | | ![](static/gui/lanswitch.gif) | Switch | Ethernet switch intelligently forwards incoming packets to attached hosts using an Ethernet address hash table. |
| ![](static/gui/wlan.gif) | Wireless LAN | When routers are connected to this WLAN node, they join a wireless network and an antenna is drawn instead of a connecting line; the WLAN node typically controls connectivity between attached wireless nodes based on the distance between them. | | ![](static/gui/wlan.gif) | Wireless LAN | When routers are connected to this WLAN node, they join a wireless network and an antenna is drawn instead of a connecting line; the WLAN node typically controls connectivity between attached wireless nodes based on the distance between them. |
@ -128,7 +128,7 @@ purpose described below.
### Annotation Tools ### Annotation Tools
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |-------------------------------|-----------|---------------------------------------------------------------------|
| ![](static/gui/marker.gif) | Marker | For drawing marks on the canvas. | | ![](static/gui/marker.gif) | Marker | For drawing marks on the canvas. |
| ![](static/gui/oval.gif) | Oval | For drawing circles on the canvas that appear in the background. | | ![](static/gui/oval.gif) | Oval | For drawing circles on the canvas that appear in the background. |
| ![](static/gui/rectangle.gif) | Rectangle | For drawing rectangles on the canvas that appear in the background. | | ![](static/gui/rectangle.gif) | Rectangle | For drawing rectangles on the canvas that appear in the background. |
@ -141,7 +141,7 @@ toolbar on the left of the CORE window is replaced with the Execution toolbar
Below are the items on this toolbar, starting from the top. Below are the items on this toolbar, starting from the top.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |-----------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![](static/gui/select.gif) | Selection Tool | In Execute mode, the Selection Tool can be used for moving nodes around the canvas, and double-clicking on a node will open a shell window for that node; right-clicking on a node invokes a pop-up menu of run-time options for that node. | | ![](static/gui/select.gif) | Selection Tool | In Execute mode, the Selection Tool can be used for moving nodes around the canvas, and double-clicking on a node will open a shell window for that node; right-clicking on a node invokes a pop-up menu of run-time options for that node. |
| ![](static/gui/stop.gif) | Stop Button | Stops Execute mode, terminates the emulation, returns CORE to edit mode. | | ![](static/gui/stop.gif) | Stop Button | Stops Execute mode, terminates the emulation, returns CORE to edit mode. |
| ![](static/gui/observe.gif) | Observer Widgets Tool | Clicking on this magnifying glass icon invokes a menu for easily selecting an Observer Widget. The icon has a darker gray background when an Observer Widget is active, during which time moving the mouse over a node will pop up an information display for that node. | | ![](static/gui/observe.gif) | Observer Widgets Tool | Clicking on this magnifying glass icon invokes a menu for easily selecting an Observer Widget. The icon has a darker gray background when an Observer Widget is active, during which time moving the mouse over a node will pop up an information display for that node. |
@ -161,7 +161,7 @@ The File menu contains options for manipulating the **.imn** Configuration
Files. Generally, these menu items should not be used in Execute mode. Files. Generally, these menu items should not be used in Execute mode.
| Option | Description | | Option | Description |
|---|---| |------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| New | This starts a new file with an empty canvas. | | New | This starts a new file with an empty canvas. |
| Open | Invokes the File Open dialog box for selecting a new **.imn** or XML file to open. You can change the default path used for this dialog in the Preferences Dialog. | | Open | Invokes the File Open dialog box for selecting a new **.imn** or XML file to open. You can change the default path used for this dialog in the Preferences Dialog. |
| Save | Saves the current topology. If you have not yet specified a file name, the Save As dialog box is invoked. | | Save | Saves the current topology. If you have not yet specified a file name, the Save As dialog box is invoked. |
@ -179,10 +179,10 @@ Files. Generally, these menu items should not be used in Execute mode.
### Edit Menu ### Edit Menu
| Option | Description | | Option | Description |
|---|---| |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Undo | Attempts to undo the last edit in edit mode. | | Undo | Attempts to undo the last edit in edit mode. |
| Redo | Attempts to redo an edit that has been undone. | | Redo | Attempts to redo an edit that has been undone. |
| Cut, Copy, Paste | Used to cut, copy, and paste a selection. When nodes are pasted, their node numbers are automatically incremented, and existing links are preserved with new IP addresses assigned. Services and their customizations are copied to the new node, but care should be taken as node IP addresses have changed with possibly old addresses remaining in any custom service configurations. Annotations may also be copied and pasted. | Cut, Copy, Paste | Used to cut, copy, and paste a selection. When nodes are pasted, their node numbers are automatically incremented, and existing links are preserved with new IP addresses assigned. Services and their customizations are copied to the new node, but care should be taken as node IP addresses have changed with possibly old addresses remaining in any custom service configurations. Annotations may also be copied and pasted. |
| Select All | Selects all items on the canvas. Selected items can be moved as a group. | | Select All | Selects all items on the canvas. Selected items can be moved as a group. |
| Select Adjacent | Select all nodes that are linked to the already selected node(s). For wireless nodes this simply selects the WLAN node(s) that the wireless node belongs to. You can use this by clicking on a node and pressing CTRL+N to select the adjacent nodes. | | Select Adjacent | Select all nodes that are linked to the already selected node(s). For wireless nodes this simply selects the WLAN node(s) that the wireless node belongs to. You can use this by clicking on a node and pressing CTRL+N to select the adjacent nodes. |
| Find... | Invokes the *Find* dialog box. The Find dialog can be used to search for nodes by name or number. Results are listed in a table that includes the node or link location and details such as IP addresses or link parameters. Clicking on a result will focus the canvas on that node or link, switching canvases if necessary. | | Find... | Invokes the *Find* dialog box. The Find dialog can be used to search for nodes by name or number. Results are listed in a table that includes the node or link location and details such as IP addresses or link parameters. Clicking on a result will focus the canvas on that node or link, switching canvases if necessary. |
@ -195,11 +195,11 @@ The canvas menu provides commands for adding, removing, changing, and switching
to different editing canvases. to different editing canvases.
| Option | Description | | Option | Description |
|---|---| |-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| New | Creates a new empty canvas at the right of all existing canvases. | | New | Creates a new empty canvas at the right of all existing canvases. |
| Manage... | Invokes the *Manage Canvases* dialog box, where canvases may be renamed and reordered, and you can easily switch to one of the canvases by selecting it. | | Manage... | Invokes the *Manage Canvases* dialog box, where canvases may be renamed and reordered, and you can easily switch to one of the canvases by selecting it. |
| Delete | Deletes the current canvas and all items that it contains. | | Delete | Deletes the current canvas and all items that it contains. |
| Size/scale... | Invokes a Canvas Size and Scale dialog that allows configuring the canvas size, scale, and geographic reference point. The size controls allow changing the width and height of the current canvas, in pixels or meters. The scale allows specifying how many meters are equivalent to 100 pixels. The reference point controls specify the latitude, longitude, and altitude reference point used to convert between geographic and Cartesian coordinate systems. By clicking the *Save as default* option, all new canvases will be created with these properties. The default canvas size can also be changed in the Preferences dialog box. | Size/scale... | Invokes a Canvas Size and Scale dialog that allows configuring the canvas size, scale, and geographic reference point. The size controls allow changing the width and height of the current canvas, in pixels or meters. The scale allows specifying how many meters are equivalent to 100 pixels. The reference point controls specify the latitude, longitude, and altitude reference point used to convert between geographic and Cartesian coordinate systems. By clicking the *Save as default* option, all new canvases will be created with these properties. The default canvas size can also be changed in the Preferences dialog box. |
| Wallpaper... | Used for setting the canvas background image. | | Wallpaper... | Used for setting the canvas background image. |
| Previous, Next, First, Last | Used for switching the active canvas to the first, last, or adjacent canvas. | | Previous, Next, First, Last | Used for switching the active canvas to the first, last, or adjacent canvas. |
@ -209,7 +209,7 @@ The View menu features items for controlling what is displayed on the drawing
canvas. canvas.
| Option | Description | | Option | Description |
|---|---| |-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Show | Opens a submenu of items that can be displayed or hidden, such as interface names, addresses, and labels. Use these options to help declutter the display. These options are generally saved in the topology files, so scenarios have a more consistent look when copied from one computer to another. | | Show | Opens a submenu of items that can be displayed or hidden, such as interface names, addresses, and labels. Use these options to help declutter the display. These options are generally saved in the topology files, so scenarios have a more consistent look when copied from one computer to another. |
| Show hidden nodes | Reveal nodes that have been hidden. Nodes are hidden by selecting one or more nodes, right-clicking one and choosing *hide*. | | Show hidden nodes | Reveal nodes that have been hidden. Nodes are hidden by selecting one or more nodes, right-clicking one and choosing *hide*. |
| Locked | Toggles locked view; when the view is locked, nodes cannot be moved around on the canvas with the mouse. This could be useful when sharing the topology with someone and you do not expect them to change things. | | Locked | Toggles locked view; when the view is locked, nodes cannot be moved around on the canvas with the mouse. This could be useful when sharing the topology with someone and you do not expect them to change things. |
@ -222,7 +222,7 @@ canvas.
The tools menu lists different utility functions. The tools menu lists different utility functions.
| Option | Description | | Option | Description |
|---|---| |------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Autorearrange all | Automatically arranges all nodes on the canvas. Nodes having a greater number of links are moved to the center. This mode can continue to run while placing nodes. To turn off this autorearrange mode, click on a blank area of the canvas with the select tool, or choose this menu option again. | | Autorearrange all | Automatically arranges all nodes on the canvas. Nodes having a greater number of links are moved to the center. This mode can continue to run while placing nodes. To turn off this autorearrange mode, click on a blank area of the canvas with the select tool, or choose this menu option again. |
| Autorearrange selected | Automatically arranges the selected nodes on the canvas. | | Autorearrange selected | Automatically arranges the selected nodes on the canvas. |
| Align to grid | Moves nodes into a grid formation, starting with the smallest-numbered node in the upper-left corner of the canvas, arranging nodes in vertical columns. | | Align to grid | Moves nodes into a grid formation, starting with the smallest-numbered node in the upper-left corner of the canvas, arranging nodes in vertical columns. |
@ -238,7 +238,7 @@ The tools menu lists different utility functions.
#### Topology Generator #### Topology Generator
| Pattern | Description | | Pattern | Description |
|---|---| |----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Random | Nodes are randomly placed about the canvas, but are not linked together. This can be used in conjunction with a WLAN node to quickly create a wireless network. | | Random | Nodes are randomly placed about the canvas, but are not linked together. This can be used in conjunction with a WLAN node to quickly create a wireless network. |
| Grid | Nodes are placed in horizontal rows starting in the upper-left corner, evenly spaced to the right; nodes are not linked to each other. | | Grid | Nodes are placed in horizontal rows starting in the upper-left corner, evenly spaced to the right; nodes are not linked to each other. |
| Connected Grid | Nodes are placed in an N x M (width and height) rectangular grid, and each node is linked to the node above, below, left and right of itself. | | Connected Grid | Nodes are placed in an N x M (width and height) rectangular grid, and each node is linked to the node above, below, left and right of itself. |
@ -307,7 +307,7 @@ in addition to global options such as node types, comments, hooks, servers,
and options. and options.
| Option | Description | | Option | Description |
|---|---| |----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Start or Stop | This starts or stops the emulation, performing the same function as the green Start or red Stop button. | | Start or Stop | This starts or stops the emulation, performing the same function as the green Start or red Stop button. |
| Change sessions... | Invokes the CORE Sessions dialog box containing a list of active CORE sessions in the daemon. Basic session information such as name, node count, start time, and a thumbnail are displayed. This dialog allows connecting to different sessions, shutting them down, or starting a new session. | | Change sessions... | Invokes the CORE Sessions dialog box containing a list of active CORE sessions in the daemon. Basic session information such as name, node count, start time, and a thumbnail are displayed. This dialog allows connecting to different sessions, shutting them down, or starting a new session. |
| Node types... | Invokes the CORE Node Types dialog, performing the same function as the Edit button on the Network-Layer Nodes toolbar. | | Node types... | Invokes the CORE Node Types dialog, performing the same function as the Edit button on the Network-Layer Nodes toolbar. |
@ -321,18 +321,18 @@ and options.
#### Session States #### Session States
| State | Description | | State | Description |
|---|---| |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| definition | Used by the GUI to tell the backend to clear any state. | | definition | Used by the GUI to tell the backend to clear any state. |
| configuration | When the user presses the *Start* button, node, link, and other configuration data is sent to the backend. This state is also reached when the user customizes a service. | | configuration | When the user presses the *Start* button, node, link, and other configuration data is sent to the backend. This state is also reached when the user customizes a service. |
| instantiation | After configuration data has been sent, just before the nodes are created. | | instantiation | After configuration data has been sent, just before the nodes are created. |
| runtime | All nodes and networks have been built and are running. (This is the same state at which the previously-named *global experiment script* was run.) | runtime | All nodes and networks have been built and are running. (This is the same state at which the previously-named *global experiment script* was run.) |
| datacollect | The user has pressed the *Stop* button, but before services have been stopped and nodes have been shut down. This is a good time to collect log files and other data from the nodes. | | datacollect | The user has pressed the *Stop* button, but before services have been stopped and nodes have been shut down. This is a good time to collect log files and other data from the nodes. |
| shutdown | All nodes and networks have been shut down and destroyed. | | shutdown | All nodes and networks have been shut down and destroyed. |
### Help Menu ### Help Menu
| Option | Description | | Option | Description |
|---|---| |--------------------------|---------------------------------------------------------------|
| CORE Github (www) | Link to the CORE GitHub page. | | CORE Github (www) | Link to the CORE GitHub page. |
| CORE Documentation (www) | Lnk to the CORE Documentation page. | | CORE Documentation (www) | Lnk to the CORE Documentation page. |
| About | Invokes the About dialog box for viewing version information. | | About | Invokes the About dialog box for viewing version information. |
@ -542,10 +542,10 @@ complexity and CPU usage. The availability of certain plug-ins varies depending
on platform. See the table below for a brief overview of wireless model types. on platform. See the table below for a brief overview of wireless model types.
|Model|Type|Supported Platform(s)|Fidelity|Description| | Model | Type | Supported Platform(s) | Fidelity | Description |
|-----|----|---------------------|--------|-----------| |-------|---------|-----------------------|----------|-------------------------------------------------------------------------------|
|Basic|on/off|Linux|Low|Ethernet bridging with nftables| | Basic | on/off | Linux | Low | Ethernet bridging with nftables |
|EMANE|Plug-in|Linux|High|TAP device connected to EMANE emulator with pluggable MAC and PHY radio types| | EMANE | Plug-in | Linux | High | TAP device connected to EMANE emulator with pluggable MAC and PHY radio types |
To quickly build a wireless network, you can first place several router nodes To quickly build a wireless network, you can first place several router nodes
onto the canvas. If you have the onto the canvas. If you have the
@ -582,7 +582,7 @@ See the [EMANE](emane.md) chapter for details on using EMANE.
CORE has a few ways to script mobility. CORE has a few ways to script mobility.
| Option | Description | | Option | Description |
|---|---| |--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ns-2 script | The script specifies either absolute positions or waypoints with a velocity. Locations are given with Cartesian coordinates. | | ns-2 script | The script specifies either absolute positions or waypoints with a velocity. Locations are given with Cartesian coordinates. |
| CORE API | An external entity can move nodes by sending CORE API Node messages with updated X,Y coordinates; the **coresendmsg** utility allows a shell script to generate these messages. | | CORE API | An external entity can move nodes by sending CORE API Node messages with updated X,Y coordinates; the **coresendmsg** utility allows a shell script to generate these messages. |
| EMANE events | See [EMANE](emane.md) for details on using EMANE scripts to move nodes around. Location information is typically given as latitude, longitude, and altitude. | | EMANE events | See [EMANE](emane.md) for details on using EMANE scripts to move nodes around. Location information is typically given as latitude, longitude, and altitude. |

32
docs/index.md
View file

@ -18,22 +18,22 @@ networking scenarios, security studies, and increasing the size of physical test
## Topics ## Topics
| Topic | Description| | Topic | Description |
|-------|------------| |--------------------------------------|-------------------------------------------------------------------|
|[Installation](install.md)|How to install CORE and its requirements| | [Installation](install.md) | How to install CORE and its requirements |
|[Architecture](architecture.md)|Overview of the architecture| | [Architecture](architecture.md) | Overview of the architecture |
|[Node Types](nodetypes.md)|Overview of node types supported within CORE| | [Node Types](nodetypes.md) | Overview of node types supported within CORE |
|[GUI](gui.md)|How to use the GUI| | [Python GUI](pygui.md) | How to use the default python based GUI |
|[(BETA) Python GUI](pygui.md)|How to use the BETA python based GUI| | [Legacy GUI (deprecated)](gui.md) | How to use the deprecated Tcl based GUI |
|[Python API](python.md)|Covers how to control core directly using python| | [Python API](python.md) | Covers how to control core directly using python |
|[gRPC API](grpc.md)|Covers how control core using gRPC| | [gRPC API](grpc.md) | Covers how control core using gRPC |
|[Distributed](distributed.md)|Details for running CORE across multiple servers| | [Distributed](distributed.md) | Details for running CORE across multiple servers |
|[Control Network](ctrlnet.md)|How to use control networks to communicate with nodes from host| | [Control Network](ctrlnet.md) | How to use control networks to communicate with nodes from host |
|[Config Services](configservices.md)|Overview of provided config services and creating custom ones| | [Config Services](configservices.md) | Overview of provided config services and creating custom ones |
|[Services](services.md)|Overview of provided services and creating custom ones| | [Services](services.md) | Overview of provided services and creating custom ones |
|[EMANE](emane.md)|Overview of EMANE integration and integrating custom EMANE models| | [EMANE](emane.md) | Overview of EMANE integration and integrating custom EMANE models |
|[Performance](performance.md)|Notes on performance when using CORE| | [Performance](performance.md) | Notes on performance when using CORE |
|[Developers Guide](devguide.md)|Overview on how to contribute to CORE| | [Developers Guide](devguide.md) | Overview on how to contribute to CORE |
## Credits ## Credits

14
docs/install.md
View file

@ -37,12 +37,12 @@ sudo modprobe sch_netem
### Tools Used ### Tools Used
The following tools will be leveraged during installation: The following tools will be leveraged during installation:
|Tool|Description| | Tool | Description |
|---|---| |---------------------------------------------|-----------------------------------------------------------------------|
|[pip](https://pip.pypa.io/en/stable/)|used to install pipx| | [pip](https://pip.pypa.io/en/stable/) | used to install pipx |
|[pipx](https://pipxproject.github.io/pipx/)|used to install standalone python tools (invoke, poetry)| | [pipx](https://pipxproject.github.io/pipx/) | used to install standalone python tools (invoke, poetry) |
|[invoke](http://www.pyinvoke.org/)|used to run provided tasks (install, uninstall, reinstall, etc)| | [invoke](http://www.pyinvoke.org/) | used to run provided tasks (install, uninstall, reinstall, etc) |
|[poetry](https://python-poetry.org/)|used to install python virtual environment or building a python wheel| | [poetry](https://python-poetry.org/) | used to install python virtual environment or building a python wheel |
### Files ### Files
The following is a list of files that would be installed after running the automated installation. The following is a list of files that would be installed after running the automated installation.
@ -74,7 +74,7 @@ The following is a list of files that would be installed after running the autom
After the installation complete it will have installed the following scripts. After the installation complete it will have installed the following scripts.
| Name | Description | | Name | Description |
|---|---| |---------------------|------------------------------------------------------------------------------|
| core-cleanup | tool to help removed lingering core created containers, bridges, directories | | core-cleanup | tool to help removed lingering core created containers, bridges, directories |
| core-cli | tool to query, open xml files, and send commands using gRPC | | core-cli | tool to query, open xml files, and send commands using gRPC |
| core-daemon | runs the backed core server providing TLV and gRPC APIs | | core-daemon | runs the backed core server providing TLV and gRPC APIs |

2
docs/performance.md
View file

@ -9,7 +9,7 @@ The top question about the performance of CORE is often *how many nodes can it
handle?* The answer depends on several factors: handle?* The answer depends on several factors:
| Factor | Performance Impact | | Factor | Performance Impact |
|---|---| |--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Hardware | the number and speed of processors in the computer, the available processor cache, RAM memory, and front-side bus speed may greatly affect overall performance. | | Hardware | the number and speed of processors in the computer, the available processor cache, RAM memory, and front-side bus speed may greatly affect overall performance. |
| Operating system version | distribution of Linux and the specific kernel versions used will affect overall performance. | | Operating system version | distribution of Linux and the specific kernel versions used will affect overall performance. |
| Active processes | all nodes share the same CPU resources, so if one or more nodes is performing a CPU-intensive task, overall performance will suffer. | | Active processes | all nodes share the same CPU resources, so if one or more nodes is performing a CPU-intensive task, overall performance will suffer. |

42
docs/pygui.md
View file

@ -115,7 +115,7 @@ item, starting from the top. Most of the tools are grouped into related
sub-menus, which appear when you click on their group icon. sub-menus, which appear when you click on their group icon.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |------------------------------|----------------|----------------------------------------------------------------------------------------|
| ![](static/pygui/select.png) | Selection Tool | Tool for selecting, moving, configuring nodes. | | ![](static/pygui/select.png) | Selection Tool | Tool for selecting, moving, configuring nodes. |
| ![](static/pygui/start.png) | Start Button | Starts Execute mode, instantiates the emulation. | | ![](static/pygui/start.png) | Start Button | Starts Execute mode, instantiates the emulation. |
| ![](static/pygui/link.png) | Link | Allows network links to be drawn between two nodes by clicking and dragging the mouse. | | ![](static/pygui/link.png) | Link | Allows network links to be drawn between two nodes by clicking and dragging the mouse. |
@ -125,7 +125,7 @@ sub-menus, which appear when you click on their group icon.
These nodes will create a new node container and run associated services. These nodes will create a new node container and run associated services.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |------------------------------|---------|------------------------------------------------------------------------------|
| ![](static/pygui/router.png) | Router | Runs Quagga OSPFv2 and OSPFv3 routing to forward packets. | | ![](static/pygui/router.png) | Router | Runs Quagga OSPFv2 and OSPFv3 routing to forward packets. |
| ![](static/pygui/host.png) | Host | Emulated server machine having a default route, runs SSH server. | | ![](static/pygui/host.png) | Host | Emulated server machine having a default route, runs SSH server. |
| ![](static/pygui/pc.png) | PC | Basic emulated machine having a default route, runs no processes by default. | | ![](static/pygui/pc.png) | PC | Basic emulated machine having a default route, runs no processes by default. |
@ -138,7 +138,7 @@ These nodes are mostly used to create a Linux bridge that serves the
purpose described below. purpose described below.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |---------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![](static/pygui/hub.png) | Hub | Ethernet hub forwards incoming packets to every connected node. | | ![](static/pygui/hub.png) | Hub | Ethernet hub forwards incoming packets to every connected node. |
| ![](static/pygui/lanswitch.png) | Switch | Ethernet switch intelligently forwards incoming packets to attached hosts using an Ethernet address hash table. | | ![](static/pygui/lanswitch.png) | Switch | Ethernet switch intelligently forwards incoming packets to attached hosts using an Ethernet address hash table. |
| ![](static/pygui/wlan.png) | Wireless LAN | When routers are connected to this WLAN node, they join a wireless network and an antenna is drawn instead of a connecting line; the WLAN node typically controls connectivity between attached wireless nodes based on the distance between them. | | ![](static/pygui/wlan.png) | Wireless LAN | When routers are connected to this WLAN node, they join a wireless network and an antenna is drawn instead of a connecting line; the WLAN node typically controls connectivity between attached wireless nodes based on the distance between them. |
@ -148,7 +148,7 @@ purpose described below.
### Annotation Tools ### Annotation Tools
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |---------------------------------|-----------|---------------------------------------------------------------------|
| ![](static/pygui/marker.png) | Marker | For drawing marks on the canvas. | | ![](static/pygui/marker.png) | Marker | For drawing marks on the canvas. |
| ![](static/pygui/oval.png) | Oval | For drawing circles on the canvas that appear in the background. | | ![](static/pygui/oval.png) | Oval | For drawing circles on the canvas that appear in the background. |
| ![](static/pygui/rectangle.png) | Rectangle | For drawing rectangles on the canvas that appear in the background. | | ![](static/pygui/rectangle.png) | Rectangle | For drawing rectangles on the canvas that appear in the background. |
@ -161,7 +161,7 @@ toolbar on the left of the CORE window is replaced with the Execution toolbar
Below are the items on this toolbar, starting from the top. Below are the items on this toolbar, starting from the top.
| Icon | Name | Description | | Icon | Name | Description |
|---|---|---| |------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![](static/pygui/stop.png) | Stop Button | Stops Execute mode, terminates the emulation, returns CORE to edit mode. | | ![](static/pygui/stop.png) | Stop Button | Stops Execute mode, terminates the emulation, returns CORE to edit mode. |
| ![](static/pygui/select.png) | Selection Tool | In Execute mode, the Selection Tool can be used for moving nodes around the canvas, and double-clicking on a node will open a shell window for that node; right-clicking on a node invokes a pop-up menu of run-time options for that node. | | ![](static/pygui/select.png) | Selection Tool | In Execute mode, the Selection Tool can be used for moving nodes around the canvas, and double-clicking on a node will open a shell window for that node; right-clicking on a node invokes a pop-up menu of run-time options for that node. |
| ![](static/pygui/marker.png) | Marker | For drawing freehand lines on the canvas, useful during demonstrations; markings are not saved. | | ![](static/pygui/marker.png) | Marker | For drawing freehand lines on the canvas, useful during demonstrations; markings are not saved. |
@ -179,7 +179,7 @@ The File menu contains options for manipulating the **.imn** Configuration
Files. Generally, these menu items should not be used in Execute mode. Files. Generally, these menu items should not be used in Execute mode.
| Option | Description | | Option | Description |
|---|---| |-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| New Session | This starts a new session with an empty canvas. | | New Session | This starts a new session with an empty canvas. |
| Save | Saves the current topology. If you have not yet specified a file name, the Save As dialog box is invoked. | | Save | Saves the current topology. If you have not yet specified a file name, the Save As dialog box is invoked. |
| Save As | Invokes the Save As dialog box for selecting a new **.xml** file for saving the current configuration in the XML file. | | Save As | Invokes the Save As dialog box for selecting a new **.xml** file for saving the current configuration in the XML file. |
@ -191,20 +191,20 @@ Files. Generally, these menu items should not be used in Execute mode.
### Edit Menu ### Edit Menu
| Option | Description | | Option | Description |
|---|---| |--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Preferences | Invokes the Preferences dialog box. | | Preferences | Invokes the Preferences dialog box. |
| Custom Nodes | Custom node creation dialog box. | | Custom Nodes | Custom node creation dialog box. |
| Undo | (Disabled) Attempts to undo the last edit in edit mode. | | Undo | (Disabled) Attempts to undo the last edit in edit mode. |
| Redo | (Disabled) Attempts to redo an edit that has been undone. | | Redo | (Disabled) Attempts to redo an edit that has been undone. |
| Cut, Copy, Paste, Delete | Used to cut, copy, paste, and delete a selection. When nodes are pasted, their node numbers are automatically incremented, and existing links are preserved with new IP addresses assigned. Services and their customizations are copied to the new node, but care should be taken as node IP addresses have changed with possibly old addresses remaining in any custom service configurations. Annotations may also be copied and pasted. | Cut, Copy, Paste, Delete | Used to cut, copy, paste, and delete a selection. When nodes are pasted, their node numbers are automatically incremented, and existing links are preserved with new IP addresses assigned. Services and their customizations are copied to the new node, but care should be taken as node IP addresses have changed with possibly old addresses remaining in any custom service configurations. Annotations may also be copied and pasted. |
### Canvas Menu ### Canvas Menu
The canvas menu provides commands related to the editing canvas. The canvas menu provides commands related to the editing canvas.
| Option | Description | | Option | Description |
|---|---| |------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Size/scale | Invokes a Canvas Size and Scale dialog that allows configuring the canvas size, scale, and geographic reference point. The size controls allow changing the width and height of the current canvas, in pixels or meters. The scale allows specifying how many meters are equivalent to 100 pixels. The reference point controls specify the latitude, longitude, and altitude reference point used to convert between geographic and Cartesian coordinate systems. By clicking the *Save as default* option, all new canvases will be created with these properties. The default canvas size can also be changed in the Preferences dialog box. | Size/scale | Invokes a Canvas Size and Scale dialog that allows configuring the canvas size, scale, and geographic reference point. The size controls allow changing the width and height of the current canvas, in pixels or meters. The scale allows specifying how many meters are equivalent to 100 pixels. The reference point controls specify the latitude, longitude, and altitude reference point used to convert between geographic and Cartesian coordinate systems. By clicking the *Save as default* option, all new canvases will be created with these properties. The default canvas size can also be changed in the Preferences dialog box. |
| Wallpaper | Used for setting the canvas background image. | | Wallpaper | Used for setting the canvas background image. |
### View Menu ### View Menu
@ -212,7 +212,7 @@ The canvas menu provides commands related to the editing canvas.
The View menu features items for toggling on and off their display on the canvas. The View menu features items for toggling on and off their display on the canvas.
| Option | Description | | Option | Description |
|---|---| |-----------------|-----------------------------------|
| Interface Names | Display interface names on links. | | Interface Names | Display interface names on links. |
| IPv4 Addresses | Display IPv4 addresses on links. | | IPv4 Addresses | Display IPv4 addresses on links. |
| IPv6 Addresses | Display IPv6 addresses on links. | | IPv6 Addresses | Display IPv6 addresses on links. |
@ -226,7 +226,7 @@ The View menu features items for toggling on and off their display on the canvas
The tools menu lists different utility functions. The tools menu lists different utility functions.
| Option | Description | | Option | Description |
|---|---| |---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Find | Display find dialog used for highlighting a node on the canvas. | | Find | Display find dialog used for highlighting a node on the canvas. |
| Auto Grid | Automatically layout nodes in a grid. | | Auto Grid | Automatically layout nodes in a grid. |
| IP addresses | Invokes the IP Addresses dialog box for configuring which IPv4/IPv6 prefixes are used when automatically addressing new interfaces. | | IP addresses | Invokes the IP Addresses dialog box for configuring which IPv4/IPv6 prefixes are used when automatically addressing new interfaces. |
@ -289,7 +289,7 @@ in addition to global options such as node types, comments, hooks, servers,
and options. and options.
| Option | Description | | Option | Description |
|---|---| |----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Sessions | Invokes the CORE Sessions dialog box containing a list of active CORE sessions in the daemon. Basic session information such as name, node count, start time, and a thumbnail are displayed. This dialog allows connecting to different sessions, shutting them down, or starting a new session. | | Sessions | Invokes the CORE Sessions dialog box containing a list of active CORE sessions in the daemon. Basic session information such as name, node count, start time, and a thumbnail are displayed. This dialog allows connecting to different sessions, shutting them down, or starting a new session. |
| Servers | Invokes the CORE emulation servers dialog for configuring. | | Servers | Invokes the CORE emulation servers dialog for configuring. |
| Options | Presents per-session options, such as the IPv4 prefix to be used, if any, for a control network the ability to preserve the session directory; and an on/off switch for SDT3D support. | | Options | Presents per-session options, such as the IPv4 prefix to be used, if any, for a control network the ability to preserve the session directory; and an on/off switch for SDT3D support. |
@ -298,18 +298,18 @@ and options.
#### Session States #### Session States
| State | Description | | State | Description |
|---|---| |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Definition | Used by the GUI to tell the backend to clear any state. | | Definition | Used by the GUI to tell the backend to clear any state. |
| Configuration | When the user presses the *Start* button, node, link, and other configuration data is sent to the backend. This state is also reached when the user customizes a service. | | Configuration | When the user presses the *Start* button, node, link, and other configuration data is sent to the backend. This state is also reached when the user customizes a service. |
| Instantiation | After configuration data has been sent, just before the nodes are created. | | Instantiation | After configuration data has been sent, just before the nodes are created. |
| Runtime | All nodes and networks have been built and are running. (This is the same state at which the previously-named *global experiment script* was run.) | Runtime | All nodes and networks have been built and are running. (This is the same state at which the previously-named *global experiment script* was run.) |
| Datacollect | The user has pressed the *Stop* button, but before services have been stopped and nodes have been shut down. This is a good time to collect log files and other data from the nodes. | | Datacollect | The user has pressed the *Stop* button, but before services have been stopped and nodes have been shut down. This is a good time to collect log files and other data from the nodes. |
| Shutdown | All nodes and networks have been shut down and destroyed. | | Shutdown | All nodes and networks have been shut down and destroyed. |
### Help Menu ### Help Menu
| Option | Description | | Option | Description |
|---|---| |--------------------------|---------------------------------------------------------------|
| CORE Github (www) | Link to the CORE GitHub page. | | CORE Github (www) | Link to the CORE GitHub page. |
| CORE Documentation (www) | Lnk to the CORE Documentation page. | | CORE Documentation (www) | Lnk to the CORE Documentation page. |
| About | Invokes the About dialog box for viewing version information. | | About | Invokes the About dialog box for viewing version information. |
@ -519,10 +519,10 @@ complexity and CPU usage. The availability of certain plug-ins varies depending
on platform. See the table below for a brief overview of wireless model types. on platform. See the table below for a brief overview of wireless model types.
|Model|Type|Supported Platform(s)|Fidelity|Description| | Model | Type | Supported Platform(s) | Fidelity | Description |
|-----|----|---------------------|--------|-----------| |-------|---------|-----------------------|----------|-------------------------------------------------------------------------------|
|Basic|on/off|Linux|Low|Ethernet bridging with nftables| | Basic | on/off | Linux | Low | Ethernet bridging with nftables |
|EMANE|Plug-in|Linux|High|TAP device connected to EMANE emulator with pluggable MAC and PHY radio types| | EMANE | Plug-in | Linux | High | TAP device connected to EMANE emulator with pluggable MAC and PHY radio types |
To quickly build a wireless network, you can first place several router nodes To quickly build a wireless network, you can first place several router nodes
onto the canvas. If you have the onto the canvas. If you have the
@ -557,7 +557,7 @@ See the [EMANE](emane.md) chapter for details on using EMANE.
CORE has a few ways to script mobility. CORE has a few ways to script mobility.
| Option | Description | | Option | Description |
|---|---| |--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ns-2 script | The script specifies either absolute positions or waypoints with a velocity. Locations are given with Cartesian coordinates. | | ns-2 script | The script specifies either absolute positions or waypoints with a velocity. Locations are given with Cartesian coordinates. |
| CORE API | An external entity can move nodes by sending CORE API Node messages with updated X,Y coordinates; the **coresendmsg** utility allows a shell script to generate these messages. | | CORE API | An external entity can move nodes by sending CORE API Node messages with updated X,Y coordinates; the **coresendmsg** utility allows a shell script to generate these messages. |
| EMANE events | See [EMANE](emane.md) for details on using EMANE scripts to move nodes around. Location information is typically given as latitude, longitude, and altitude. | | EMANE events | See [EMANE](emane.md) for details on using EMANE scripts to move nodes around. Location information is typically given as latitude, longitude, and altitude. |

22
docs/services.md
View file

@ -22,23 +22,23 @@ shutdown commands, and meta-data associated with a node.
## Available Services ## Available Services
| Service Group | Services | | Service Group | Services |
|---|---| |----------------------------------|-----------------------------------------------------------------------|
|[BIRD](services/bird.md)|BGP, OSPF, RADV, RIP, Static| | [BIRD](services/bird.md) | BGP, OSPF, RADV, RIP, Static |
|[EMANE](services/emane.md)|Transport Service| | [EMANE](services/emane.md) | Transport Service |
|[FRR](services/frr.md)|BABEL, BGP, OSPFv2, OSPFv3, PIMD, RIP, RIPNG, Zebra| | [FRR](services/frr.md) | BABEL, BGP, OSPFv2, OSPFv3, PIMD, RIP, RIPNG, Zebra |
|[NRL](services/nrl.md)|arouted, MGEN Sink, MGEN Actor, NHDP, OLSR, OLSRORG, OLSRv2, SMF| | [NRL](services/nrl.md) | arouted, MGEN Sink, MGEN Actor, NHDP, OLSR, OLSRORG, OLSRv2, SMF |
|[Quagga](services/quagga.md)|BABEL, BGP, OSPFv2, OSPFv3, OSPFv3 MDR, RIP, RIPNG, XPIMD, Zebra| | [Quagga](services/quagga.md) | BABEL, BGP, OSPFv2, OSPFv3, OSPFv3 MDR, RIP, RIPNG, XPIMD, Zebra |
|[SDN](services/sdn.md)|OVS, RYU| | [SDN](services/sdn.md) | OVS, RYU |
|[Security](services/security.md)|Firewall, IPsec, NAT, VPN Client, VPN Server| | [Security](services/security.md) | Firewall, IPsec, NAT, VPN Client, VPN Server |
|[Utility](services/utility.md)|ATD, Routing Utils, DHCP, FTP, IP Forward, PCAP, RADVD, SSF, UCARP| | [Utility](services/utility.md) | ATD, Routing Utils, DHCP, FTP, IP Forward, PCAP, RADVD, SSF, UCARP |
|[XORP](services/xorp.md)|BGP, OLSR, OSPFv2, OSPFv3, PIMSM4, PIMSM6, RIP, RIPNG, Router Manager| | [XORP](services/xorp.md) | BGP, OLSR, OSPFv2, OSPFv3, PIMSM4, PIMSM6, RIP, RIPNG, Router Manager |
## Node Types and Default Services ## Node Types and Default Services
Here are the default node types and their services: Here are the default node types and their services:
| Node Type | Services | | Node Type | Services |
|---|---| |-----------|--------------------------------------------------------------------------------------------------------------------------------------------|
| *router* | zebra, OSFPv2, OSPFv3, and IPForward services for IGP link-state routing. | | *router* | zebra, OSFPv2, OSPFv3, and IPForward services for IGP link-state routing. |
| *host* | DefaultRoute and SSH services, representing an SSH server having a default route when connected directly to a router. | | *host* | DefaultRoute and SSH services, representing an SSH server having a default route when connected directly to a router. |
| *PC* | DefaultRoute service for having a default route when connected directly to a router. | | *PC* | DefaultRoute service for having a default route when connected directly to a router. |