ION Quick Start Guide

IMPORTANT NOTE ON DUAL-STACK IPv4/IPv6 NETWORKING (ION 4.1.4-b.1 and later): The dual-stack IPv4/IPv6 capability will automatically use the network address family returned by hostname resolution. Most operating systems return IPv6 addresses first when available, and ION's network stack will use the first entry returned. If a host is not properly configured for the returned address family, this may cause network address family conflicts, resulting in connection failures for TCP, UDP, and LTPCLA (which runs over UDP). The most reliable approach is to use explicit IP addresses if known. If using hostnames, ensure all hosts resolve to the correct address family as the first entry in DNS resolution.

ION Quick Start Guide
Installing ION on Linux, MacOS, Solaris
Windows 7 \& Windows 10
Running ION
Running multiple ION instances on a single host
Setup UDP Configuration on Two Hosts
Launch ION on two separate hosts
Run a bpdriver-bpcounter test
Check the ion.log
bpacq and ltpacq files
Forced Shutdown of ION
Additional Tutorials
Three ION Configuration File Examples
Accessing ION Open-Source Code Repository
- Releases
- Using the code repository
Open Source Development and Support
Updated IPN-URI Format Support (ION 4.1.4-a.2)

Installing ION on Linux, MacOS, Solaris

The recommended method to install ION on most Linux-based systems is to use the automake ecosystem. For this, you will need to make sure the following packages are installed and updated:

automake
autoconf
libtool
m4
gcc
make

Depending on the Linux distribution, the package names may differ. To install packages on Debian-based systems, run:

sudo apt-get update && sudo apt-get install automake autoconf libtool m4 gcc make

To verify the installation, run:

automake --version

autoconf --version

libtool --version

m4 --version

gcc --version

make --version

to check for proper installation.

NOTE: Alternative build methods without the automake ecosystem are also available. See section Alternative Build Methods without Automake for details.

Build ION 4.1.3 (and earlier versions) without actual cipher suite

To build and install the entire ION system on a Linux, MacOS, or Solaris platform, cd into ion-open-source and enter the following commands:

./configure

If configure is not present run: autoreconf -fi first

make

sudo make install

Optionally, to run certain c-based regression tests, you need to build the test program from C code first. To do that, run:

make test

Then update the shared library cache of the linker:

sudo ldconfig

Build ION 4.1.3s (and later version) with interface to actual cipher suite

If you are not planning to use BPSec's interface to the MBEDTLS cipher suite, you can simply follow the build instruction for ION 4.1.3.

Building ION to use the MBEDTLS cipher suite

Before building ION, you should build and install MBEDTLS first. Download MBEDTLS release 2.28.8 from GitHub.

Assume you place the files in your home directory under $HOME/mbedtls-2.28.2. Now do the following:

Modify the file under $HOME/mbedtls-2.28.2/include/mbedtls/config.h
Uncomment the line #define MBEDTLS_NIST_KW_C and save the file.
Return to the root folder of MBEDTLS $HOME/mbedtls-2.28.2 and build the shared libraries: make SHARED=1
Optionally, run make check to execute self-test on the MBEDTLS libraries.
Install MBEDTLS shared library: sudo make install
- The default library installation locations are /usr/local/lib and /usr/local/include. After the installation, verify the location of the library and header files. If the MBEDTLS shared libraries are not copied into the above locations, then make a note of the full path to the actual library and header files, which will need to be provided to ION during compilation.

Now we are ready to install ION. For the ./configure command you need to enable MBEDTLS cipher suite interface using the --enable-crypto-mbedtls option. In addition, you may also optionally add the --enable-bpsec-debugging flag if you plan to run the BPSec related regression tests.

If the MBEDTLS library is not installed under the /usr/local prefix, then you will need to provide the path to the MBEDTLS library explicitly to ION by adding MBED_LIB_PATH=<path-to-mbedtls-sharedlibrary> MBED_INC_PATH=<path-to-mbedtls-header-files> to the ./configure command.

After running ./configure with the appropriate options/flags, you can build ION in the same way by:

make

sudo make install

make test (optional)

sudo ldconfig

To clean up compilation artifacts such as object files and shared libraries stored within the ION open-source directory, cd to the ION open-source directory and run:

make clean

To remove executables and shared libraries installed in the system, run:

sudo make uninstall

MAC and FreeBSD

For MacOS, the ldconfig command is not present and not necessary.

For MacOS and FreeBSD, prior to building ION, you should check whether there is sufficient system resource to run ION by running the sysctl_script.sh script in ION's root directory.

Adding Other Compile Time Switches

If you want to set additional compile-time switches for a build, the place to do this is to add them to the ./configure command. To see a list of supported ION compiler options, see the explanation provided by:

./configure -h

By default, Bundle Protocol V7 will be built and installed. Starting with ION 4.1.4-a.2, BPv6 has been removed from the codebase. All users must use BPv7 for ION 4.1.4 or later.

To build ION with enhanced watch character support, use the --enable-ewchar option.

For minimal builds targeting resource-constrained environments, ION 4.1.4-b.1 introduces options to selectively disable optional convergence layer modules:

--disable-dgr - Disable the DGR (Datagram Retransmission) convergence layer
--disable-bssp - Disable the BSSP (Bundle Streaming Service Protocol) convergence layer

These options can reduce the compiled size and runtime resource requirements when these specific convergence layers are not needed for your deployment.

For ground-based operations where operators interact with admin utilities (ionadmin, bpadmin, etc.) via terminal, the --enable-commandline-history option enables command-line history and editing (arrow keys to recall previous commands). This feature is not recommended for flight builds as it uses dynamic memory allocation. See the ION Deployment Guide for details.

To introduce customized build flags, you can add them via the ./configure in this manner:

./configure CFLAGS="<string of compiler options>"

For example, say you want to add additional source code and header files from the /wkdir/customfile and activate certain features controlled by the GDSLOGGER and GDSWATCHER - software hooks to add time stamps to ion.log and writing time-stamped watch characters to a file for analysis. This can be accomplished through the ./configure command as follows:

./configure CFLAGS="-I/wkdir/customfile -DGDSLOGGER -DGDSWATCHER"

BPSec Logging

The BPSec implementation in ION provides 4 levels of debugging/logging:

Function entry/exit logging: This logs the entry and exit of all major functions in the bpsec library and is useful for confirming control flow through the bpsec module.

Information logging: Information statements are peppered through the code to provide insight into the state of the module at processing points considered useful by bpsec module software engineers.

Warning logging: Warning statements are used to flag unexpected values that, based on runtime context, may not constitute errors.

Error logging: Errors are areas in the code where some sanity check or other required condition fails to be met by the software. Error logging within the BPSec module is of the form:

<id> <function name>: <message>

Where id is one of:

+ (function entry)
- (function exit)
i (information statement)
? (warning statement)
x (error statement)

To help users quickly verify their BP security configurations and operations are correct, the default BPSec logging level is set to 4 to provide per bundle status updates in ion.log. This is also the level required for running the python-based BPSec regression tests in the ION distribution. This level of verbosity may be too high for operation or too low for in-depth debugging. Therefore, when needed, you can recompile ION to turn BPSec logging off or set a specific logging level based on your needs.

To run BPSec logging at default level, run

./configure --enable-bpsec-logging

To run BPSec without logging, simply omit the --enable-bpsec-logging option.

To run BPSec logging at a specific level (1, 2, 3, or 4 - note 4 is the least verbose), run

./configure --enable-bpsec-logging=x

Where x is the desired logging level.

To enable the MBEDTLS cipher suite, you need to also add the --enable-crypto-mbedtls option when running the ./configure script.

Alternative Build Methods without Automake

If you do not wish to use the automake build system, you can build ION by using a set of development Makefiles or use the ion-core package.

Method 1: Using Development Makefiles

The ION distribution provides a set of Makefiles that does not rely on the automake system. This set of Makefiles is used by ION developers on Linux-based OS to offer more flexibility for compiling and debugging.

Currently, the only actively maintained platform-specific development Makefile set is for 64-bit Linux under the "x86_64-linux" folder in each module. If you choose this option, be aware of the following limitations:

For ION 4.1.1, 4.1.2 and 4.1.3:

The development Makefiles are hierarchical. There is a top-level Makefile in the ION root directory and a set of Makefiles in the individual ION modules, under the "x86_64-linux" subfolder. If you run ./configure command, it will switch to the automake system and all development Makefiles will be renamed from Makefile to Makefile.dev.
If you used the automake system and want to revert to the development Makefiles, you should first run make clean and make uninstall to completely remove ION from the system because the two compilation method builds organizes shared libraries differently. Then you can either run git stash to restore the old Makefiles or simply pull a fresh copy of the code from the repo.
The development Makefiles, as they are, provide only the default compilation options - similar to running ./configure with no arguments. If you need to set specific compiler flags, you need to modify the Makefiles directly or pass an ADD_FLAGS argument to the make all command.
The default directory for installation is /usr/local/, which usually requires sudo privilege. To override the installation prefix, change the value of OPT in the top-level Makefile of each package.

To build using the development Makefiles, cd to the ION root directory and run:

make all

OR if you need to set specific compiler flags, run:

make all ADD_FLAGS="<string of compiler options>"

Note: The make all command builds all ION executables and libraries to local bin/ and lib/ subdirectories within each module. To install these to the system directories (default: /usr/local/), run:

sudo make install && sudo ldconfig

To uninstall ION, run:

sudo make uninstall

To remove all build artifacts, run:

make clean

For ION 4.1.3s and later:

ION will be released without any Makefile. The default build method is automake. You run the ./configure command to create a single Makefile in the ION root directory.
If you want to switch to use the development Makefiles, you need to first run make clean and make uninstall to completely remove ION from the system because the two compilation method builds organizes shared libraries differently. Then you can run the script enable_manual_build.sh to clear the automake build system and replace it with the development Makefiles.

Build Individual Packages

It's also possible to build the individual packages of ION, using the development Makefiles in the package subdirectories. If you choose this option, be aware of the dependencies among the packages:

The "ici" package must be built (run make and make install) before any other package.
The "bp" package is dependent on "dgr", "ltp", and "bssp" as well as "ici"
The "cfdp", "ams", "bss", and "dtpc" packages are dependent on "bp"
The "restart" package is dependent on "cfdp", "bp", "ltp", and "ici"

For more detailed instruction on building ION, see section 2 of the "ION Design and Operation Guide" document that is distributed with this package.

Additional details are provided in the README.txt files in the root directories of the subsystems.

All Makefiles are for gmake; on a FreeBSD platform, be sure to install gmake before trying to build ION.

Method 2: Using the ion-core Package

The ion-core package contains only a subset of essential BP functionalities - particularly those features that are more stable and have been deployed for operations previously. The ion-core package can be downloaded here. Please follow the README.md file there for installation instructions.

Windows 7 & Windows 10

To install ION 4.1.2 or earlier on Windows, please download the Windows installer from the Source Forge archive.

For ION 4.1.3, no Windows installer will be provided. For more information about installation instructions on Windows 7, see Windows7-Build.pdf

For ION 4.1.3s, a Windows 10 prototype automake build system is made available for experimentation.

Running ION

Check Installed ION version

Check the ION version installed by running:

ionadmin

At the ":" prompt, please enter the single character command 'v' and you should see a response like this:

 $ ionadmin
: v
ION-OPEN-SOURCE-4.1.2

Then type 'q' to quit ionadmin. While ionadmin quits, it may display certain error messages like this:

at line 427 of ici/library/platform_sm.c, Can't get shared memory segment: Invalid argument (0)
at line 312 of ici/library/memmgr.c, Can't open memory region.
at line 367 of ici/sdr/sdrxn.c, Can't open SDR working memory.
at line 513 of ici/sdr/sdrxn.c, Can't open SDR working memory.
at line 963 of ici/library/ion.c, Can't initialize the SDR system.
Stopping ionadmin.

This is normal due to the fact that ION has not launched yet.

Try the 'bping' test

The tests directory contains regression tests used by system integrator to check ION before issuing each new release. To make sure ION is operating properly after installation, you can also manually run the bping test:

First enter the test directory: cd tests

Enter the command: ./runtests bping/

This command invokes one of the simplest test whereby two ION instances are created and a ping message is sent from one to the other and an echo is returned to the sender of the ping.

During test, ION will display the configuration files used, clean the system of existing ION instances, relaunch ION according to the test configuration files, execute bping actions, display texts that indicates what the actions are being executed in real-time, and then shutdown ION, and display the final test status message, which looks like this:

ION node ended. Log file: ion.log
TEST PASSED!

passed: 1
    bping

failed: 0

skipped: 0

excluded by OS type: 0

excluded by BP version: 0

obsolete tests: 0

In this case, the test script confirms that ION is able to execute a bping function properly.

See the ION Testset Readme for more information on how to run the regression tests.

Try to Setup a UDP Session

Under the demos folder of the ION code directory, there are benchmark tests for various ION configurations. These tests also provide a template of how to configure ION.

Take the example of the bench-udp demo:

Go into the demos/bench-udp/ folder, you will see two subfolders: 2.bench.udp and 3.bench.udp, these folders configures two ION nodes, one with node numbers 2 and 3.

Looking inside the 2.bench.udp folder, you will see specific files used to configure ION. These include:

bench.bprc
bench.ionconfig
bench.ionrc
bench.ionsecrc
bench.ipnrc
ionstart
ionstop

bench.bprc is the configuration file for the bundle protocol. To study the command options contained in this file, run man bprc.
bench.ionconfig is the configuration file for the storage configuration of ION. See man ionconfig for details.
bench.ionrc is the configuration file for ION. See man ionrc for details.
bench.ionsecrc is the configuration file for ION security administration. See man ionsecrc for details.
bench.ipnrc is the configuration file for the IPN scheme. See man ipnrc for details.
ionstart and ionstop are scripts to launch and shutdown ION.

One must note that ION distribution comes with a separate, global ionstart and ionstop scripts installed in /usr/local/bin that can launch and stop ION. The advantage of using local script is that it allows you customize the way you launch and stop ION, for example add helpful text prompt, perform additional checks and clean up activities, etc.

To run this demo test, first go into the test directory bench-udp, then run the dotest script:

./dotest

You can also study the test script to understand better what is happening.

Running multiple ION instances on a single host

If you study the test script under the "tests" and the "demos" folders, you will realize that these tests often will launch 2 or 3 ION nodes on the same host to conduct the necessary tests. While this is necessary to simplify and better automate regression testing for ION developer and integration, it is not a typical, recommended configuration for new users.

In order to run multiple ION instances in one host, specific, different IPCS keys must be used for each instance, and several variables must be set properly in the shell environment. Please see the ION Deployment Guide (included with the ION distribution) for more information on how to do that.

We recommend that most users, unless due to specific constraints that require running multiple ION instances on one host, run each ION instance on a separate host or VM.

Setup UDP Configuration on Two Hosts

Once you have studied these scripts, you can try to run it on two different machines running ION.

First, install ION in host A with an IP address of, for example, 192.168.0.2, and host B with an IP address of 192.168.0.3. Verify your installation based on earlier instructions.

Copy the 2.bench.udp folder into host A and the 3.bench.udp folder into host B.

Also copy the file global.ionrc from the bench.udp folder into the same folder where you placed 2.bench.udp and 3.bench.udp

Then you need to modify the IP addresses in the UDP demo configuration files to match the IP addresses of hosts A and B.

For example, the bprc files copied into host A is:

1
a scheme ipn 'ipnfw' 'ipnadminep'
a endpoint ipn:2.0 x
a endpoint ipn:2.1 x
a endpoint ipn:2.2 x
a endpoint ipn:2.64 x
a endpoint ipn:2.65 x
a protocol udp 1400 100
a induct udp 127.0.0.1:2113 udpcli
a outduct udp 127.0.0.1:3113 udpclo
r 'ipnadmin bench.ipnrc'
s

To make it work for host A, you need to replace the induct ip address 127.0.0.1:2113 to 192.168.0.2:2113 - this is where host A's ION will receive incoming UDP traffic.

Similarly for outduct, you want to change the ip address from 127.0.0.1:3113 to 192.168.0.3:3113 - this is where UDP traffic will go out to host B.

You can make similar modifications to the ipnrc file as well.

In the ionconfig file, you want to comment out or delete the wmKey and sdrName entries. Since we are running these two nodes on different hosts, we always let ION use the default values for these parameters.

If you don’t do this you get an error on startup.

Repeat the same updates for host B by appropriately substituting old IP address to that of the new hosts.

Launch ION on two separate hosts

After updating the configuration files on host A and B to reflect the new IP addresses and using the default wmKey (by not specifying any), we are now ready to try launching ION.

Before you try to launch ION, it is recommended that you:

Use netcat or iperf to test the connection between host A and B. Make sure it is working properly. That means have a sufficiently high data rate and low loss rate (low single digit percent or fraction of a percent should not be a concern).
If iperf tests show that the data rate between the two hosts are at or above 800 megabits per second, in both directions, and the UDP loss rate is no more than a few percent, then you are good to go.
If not, then you want to reduce the data rate in the global.ionrc file, change the data rates for the a contact command down to something similar to your connection speed. Remember, the unit in the global.ionrc file is Bytes per second, not bits per second, which is typically what iperf test report uses.
If the error rate is high, you may want to check both the physical connection or kernel buffer setting.
Check firewall setting and MTU setting may help you narrow down problems.
Using wireshark can also be helpful both for initial connection check as well as during ION testing.

Once you are ready to launch ION on both host A and B, open a terminal and go to the directory where the configuration files are stored, and run the local ionstart script:

./ionstart

Note: do not run ionstart since that will trigger the global script in the execution PATH

You should see some standard output confirming that ION launch has completed. For example you might see something like this:

Starting ION...
wmSize:          5000000
wmAddress:       0
sdrName:        'ion2'
sdrWmSize:       0
configFlags:     1
heapWords:       100000000
heapKey:         -1
logSize:         0
logKey:          -1
pathName:       '/tmp'
Stopping ionadmin.
Stopping ionadmin.
Stopping ionsecadmin.
Stopping ltpadmin.
Stopping ipnadmin.
Stopping bpadmin.

You can also see additional status information in the ion.log file in the same directory.

Launch ION on both host A and B.

Run a bpdriver-bpcounter test

Now that we have launched ION on both host A and B, it's time to send some data.

We can repeat the bping test at this point. But since you have already seen that before, let's try something different.

Let's use the bpdriver-bpcounter test utilities. This pair of utility programs simply sends a number of data in bundles from one node to another and provides a measurement on the throughput.

On host B, run this command:

bpcounter ipn:3.2 3

This command tells ION node number 3 to be ready to receive three bundles on the end-point ID ipn:3.2 which was specified in the .bprc file.

After host B has launched bpcounter, then on host A, run this command:

bpdriver 3 ipn:2.2 ipn:3.2 -10000

This command tells ION running in host A to send 3 bundles from EID 2.2 to EID 3.2, which is waiting for data (per bpcounter command.) And each bundle should be 10,000 bytes in size.

Why use the "-" sign in front of the size parameter? It's not a typo. The "-" indicates that bpdriver should keep sending bundles without waiting for any response from the receiver.

When the test completed, you should see output indicating that all the data were sent, how many bundles were transmitted/received, and at what rate.

Please note that on the sending side the transmission may appear to be almost instantaneous. That is because bpdriver, as an application, is pushing data into bundle protocol which has the ability to rate buffer the data. So as soon as the bpdriver application pushes all data into the local bundle protocol agent, it considers the transmission completed and it will report a very high throughput value, one that is far above the contact graph's data rate limit. This is not an error; it simple report the throughput as experienced by the sending application, knowing that the data has not yet delivered fully to the destination.

Throughput reported by bpcounter, on the other hand, is quite accurate if a large number of bundles are sent. To accurately measure the time it takes to send the bundles, the bpdriver program will send a "pilot" bundle just before sending the test data to signal to the bpcounter program to run its throughput calculation timer. This allows the user to run bpcounter and not have to worry about immediately sending all the bundles in order to produce an accurate throughput measurement.

If you want to emulate the action of a constant rate source, instead of having bpdriver pushing all data as fast as possible, then you can use the 'i' option to specify a data rate throttle in bits per second.

If you want to know more about how bpdriver and bpcounter work, look up their man pages for details on syntax and command line options. Other useful ION test utility commands include bpecho, bping, bpsource, bpsink, bpsendfile, bprecvfile, etc.

Check the ion.log

To confirm whether ION is running properly or has experienced an error, the first thing to do is to check the ion.log, which is a file created in the directory from which ION was launched. If an ion.log file exists when ION starts, it will simply append additional log entries into that file. Each entry has a timestamp to help you determine the time and the relative order in which events occurred.

When a serious error occurs, ion.log will have detailed messages that can pinpoint the name and line number of the source code where the error was reported or triggered.

bpacq and ltpacq files

Sometimes after operating ION for a while, you will notice a number of files with names such as "bpacq" or "ltpacq" followed by a number. These are temporary files created by ION to stage bundles or LTP blocks during reception and processing. Once a bundle or LTP block is completely constructed, delivered, or cancelled properly, these temporary files are automatically removed by ION. But if ION experiences an anomalous shutdown, then these files may remain and accumulate in the local directory.

It is generally safe to remove these files between ION runs. Their presence does not automatically imply issues with ION but can indicate that ION operations were interrupted for some reason. By noting their creation time stamp, it can provide clues on when these interruptions occurred. Right now there are no ION utility programs to parse them because these files are essentially bit buckets and do not contain internal markers or structure that would allow users to parse them or extract information by processes outside the bundle agents that created them in the first place.

Forced Shutdown of ION

Sometimes shutting down ION does not go smoothly and you can't seem to relaunch ION properly. In that case, you can use the global ionstop script (or the killm script) to kill all ION processes that did not terminate using local ionstop script. The global ionstop or killm scripts also clears out the IPC shared memory and semaphores allocations that were locked by ION processes and would not terminate otherwise.

Additional Tutorials

ION Configuration File Tutorial

To learn about the configuration files and the basic set of command syntax and functions: ION Config File Tutorial

ION Configuration File Template

ION Config File Template

ION NASA Course

To learn more about the design principle of ION and how to use it, a complete series of tutorials is available here: NASA ION Course

The ION Dev Kit mentioned in the NASA ION Course had been deprecated. However, some additional helpful files can be found here to complete the examples: Additional DevKit Files

Three ION Configuration File Examples

In this section, we provide three configuration file examples with detailed comments explaining the configuration commands. The three examples are:

Single Node Loopback over LTP
Two Nodes over TCPCL
Three Node with a relay using LTP and TCPCL

Single-Node Loopback

Here is an example configuration file for "loopback.rc" using LTP as the primary convergence layer:

FILE: loopback.rc

## Run the following command to start ION node:
##  % ionstart -I "loopback.rc"

## begin ionadmin
# Initialize node 1 with default SDR configuration
1 1 ""
s

# Add contact and range (loopback, +1 to +3600 seconds, 100000 bytes/sec, 1 sec OWLT)
a contact +1 +3600 1 1 100000
a range +1 +3600 1 1 1

# Set production and consumption rates
m production 1000000
m consumption 1000000
## end ionadmin

## begin ltpadmin
# Initialize LTP with 32 sessions
1 32

# Add span for node 1 (10 sessions, 1400 byte segments, 10000 byte blocks, 1 sec aggregation)
a span 1 10 10 1400 10000 1 'udplso localhost:1113'

# Start LTP with UDP listener on port 1113
s 'udplsi localhost:1113'
## end ltpadmin

## begin bpadmin
# Initialize with custodian endpoint ipn:1.0
1 ipn:1.0

# Add IPN scheme
a scheme ipn 'ipnfw' 'ipnadminep'

# Add endpoints
a endpoint ipn:1.0 q
a endpoint ipn:1.1 q
a endpoint ipn:1.2 q

# Add LTP protocol (1400 byte payload, 100 byte overhead)
a protocol ltp 1400 100

# Add LTP induct and outduct
a induct ltp 1 ltpcli
a outduct ltp 1 ltpclo

# Start bundle protocol engine
s
## end bpadmin

## begin ipnadmin
# Add egress plan for node 1
a plan 1 ltp/1
## end ipnadmin

Two-Node Network

In this section, we assume that host1 has an IP address of 10.1.1.1 and host2 has an IP address of 10.1.1.2. Please modify this for your uses.

Note that this example network uses a different convergence layer: TCP.

FILE: host1.rc

## Run the following command to start ION node:
## % ionstart -I "host1.rc"

## begin ionadmin
# Initialize node 1 with default SDR configuration
1 1 ""
s

# Add contacts (unidirectional, 100000 bytes/sec)
a contact +1 +3600 1 1 100000
a contact +1 +3600 1 2 100000
a contact +1 +3600 2 1 100000
a contact +1 +3600 2 2 100000

# Add ranges (bidirectional, 1 sec OWLT)
a range +1 +3600 1 1 1
a range +1 +3600 2 2 1
a range +1 +3600 2 1 1

# Set production and consumption rates
m production 1000000
m consumption 1000000
## end ionadmin

## begin bpadmin
# Initialize BP
1

# Add IPN scheme
a scheme ipn 'ipnfw' 'ipnadminep'

# Add endpoints (discard behavior 'x')
a endpoint ipn:1.0 x
a endpoint ipn:1.1 x
a endpoint ipn:1.2 x

# Add TCP protocol (1400 byte payload, 100 byte overhead)
a protocol tcp 1400 100

# Add TCP induct (listen on port 4556)
a induct tcp 10.1.1.1:4556 tcpcli

# Add TCP outducts (to self and host2)
a outduct tcp 10.1.1.1:4556 tcpclo
a outduct tcp 10.1.1.2:4556 tcpclo

# Start bundle protocol engine
s
## end bpadmin

## begin ipnadmin
# Add egress plans
a plan 1 tcp/10.1.1.1:4556
a plan 2 tcp/10.1.1.2:4556
## end ipnadmin

FILE: host2.rc

## Run the following command to start ION node:
##  % ionstart -I "host2.rc"

## begin ionadmin
# Initialize node 2 with default SDR configuration
1 2 ""
s

# Add contacts (unidirectional, 100000 bytes/sec)
a contact +1 +3600 1 1 100000
a contact +1 +3600 1 2 100000
a contact +1 +3600 2 1 100000
a contact +1 +3600 2 2 100000

# Add ranges (bidirectional, 1 sec OWLT)
a range +1 +3600 1 1 1
a range +1 +3600 2 2 1
a range +1 +3600 2 1 1

# Set production and consumption rates
m production 1000000
m consumption 1000000
## end ionadmin

## begin bpadmin
# Initialize BP
1

# Add IPN scheme
a scheme ipn 'ipnfw' 'ipnadminep'

# Add endpoints (discard behavior 'x')
a endpoint ipn:2.0 x
a endpoint ipn:2.1 x
a endpoint ipn:2.2 x

# Add TCP protocol (1400 byte payload, 100 byte overhead)
a protocol tcp 1400 100

# Add TCP induct (listen on port 4556)
a induct tcp 10.1.1.2:4556 tcpcli

# Add TCP outducts (to self and host1)
a outduct tcp 10.1.1.2:4556 tcpclo
a outduct tcp 10.1.1.1:4556 tcpclo

# Start bundle protocol engine
s
## end bpadmin

## begin ipnadmin
# Add egress plans
a plan 2 tcp/10.1.1.2:4556
a plan 1 tcp/10.1.1.1:4556
## end ipnadmin

Three-Node Relay

In this section, we assume that host1 has an IP address of 10.1.1.1, host2 has an IP address of 10.1.1.2, and host3 has an IP address of 10.1.1.3. Please modify this for your uses.

You will notice that this network uses host2 as a router in between host1 and host3. At this point, routing is handled by creating a group from the remote node and using the middle node as the gateway. Notice how host1 will take traffic for host3 and transmit it on the same outduct to host2, the next hop. Host3 will transmit traffic destined for host1 on the outduct for host2, also the next hop.

Also note that this network uses both LTP and TCP convergence layers.

FILE: host1.rc (3-node network)

## Run the following command to start ION node:
##  % ionstart -I "host1.rc"

## begin ionadmin
# Initialize node 1 with default SDR configuration
1 1 ""
s

# Add contacts for 3-node network (topology: 1--2--3)
a contact +1 +3600 1 1 100000
a contact +1 +3600 1 2 100000
a contact +1 +3600 2 1 100000
a contact +1 +3600 2 2 100000
a contact +1 +3600 2 3 100000
a contact +1 +3600 3 2 100000
a contact +1 +3600 3 3 100000

# Add ranges (1 sec OWLT for neighbors, 2 sec for node 1 to 3)
a range +1 +3600 1 1 1
a range +1 +3600 1 2 1
a range +1 +3600 1 3 2
a range +1 +3600 2 2 1
a range +1 +3600 2 3 1
a range +1 +3600 3 3 1

# Set production and consumption rates
m production 1000000
m consumption 1000000
## end ionadmin

## begin ltpadmin
# Initialize LTP with 32 sessions
1 32

# Add LTP spans (to self and host2)
a span 1 10 10 1400 10000 1 'udplso 10.1.1.1:1113'
a span 2 10 10 1400 10000 1 'udplso 10.1.1.2:1113'

# Start LTP with UDP listener on port 1113
s 'udplsi 10.1.1.1:1113'
## end ltpadmin

## begin bpadmin
# Initialize BP
1

# Add IPN scheme
a scheme ipn 'ipnfw' 'ipnadminep'

# Add endpoints (discard behavior 'x')
a endpoint ipn:1.0 x
a endpoint ipn:1.1 x
a endpoint ipn:1.2 x

# Add LTP protocol (1400 byte payload, 100 byte overhead)
a protocol ltp 1400 100

# Add LTP induct and outducts
a induct ltp 1 ltpcli
a outduct ltp 1 ltpclo
a outduct ltp 2 ltpclo

# Start bundle protocol engine
s
## end bpadmin

## begin ipnadmin
# Add egress plans for nodes 1 and 2
a plan 1 ltp/1
a plan 2 ltp/2

# Add group route: send bundles for node 3 via node 2 (gateway)
a group 3 3 ipn:2.0
## end ipnadmin

FILE: host2.rc (3-node network)

## Run the following command to start ION node:
##  % ionstart -I "host2.rc"

## begin ionadmin
# Initialize node 2 with default SDR configuration
1 2 ""
s

# Add contacts for 3-node network (topology: 1--2--3)
a contact +1 +3600 1 1 100000
a contact +1 +3600 1 2 100000
a contact +1 +3600 2 1 100000
a contact +1 +3600 2 2 100000
a contact +1 +3600 2 3 100000
a contact +1 +3600 3 2 100000
a contact +1 +3600 3 3 100000

# Add ranges (1 sec OWLT for neighbors, 2 sec for node 1 to 3)
a range +1 +3600 1 1 1
a range +1 +3600 1 2 1
a range +1 +3600 1 3 2
a range +1 +3600 2 2 1
a range +1 +3600 2 3 1
a range +1 +3600 3 3 1

# Set production and consumption rates
m production 1000000
m consumption 1000000
## end ionadmin

## begin ltpadmin
# Initialize LTP with 32 sessions
1 32

# Add LTP spans (to host1 and self)
a span 1 10 10 1400 10000 1 'udplso 10.1.1.1:1113'
a span 2 10 10 1400 10000 1 'udplso 10.1.1.2:1113'

# Start LTP with UDP listener on port 1113
s 'udplsi 10.1.1.2:1113'
## end ltpadmin

## begin bpadmin
# Initialize BP
1

# Add IPN scheme
a scheme ipn 'ipnfw' 'ipnadminep'

# Add endpoints (discard behavior 'x')
a endpoint ipn:2.0 x
a endpoint ipn:2.1 x
a endpoint ipn:2.2 x

# Add protocols (LTP and TCP)
a protocol ltp 1400 100
a protocol tcp 1400 100

# Add inducts (LTP and TCP)
a induct ltp 2 ltpcli
a induct tcp 10.1.1.2:4556 tcpcli

# Add outducts (TCP to self and host3, LTP to host1)
a outduct tcp 10.1.1.2:4556 tcpclo
a outduct tcp 10.1.1.3:4556 tcpclo
a outduct ltp 1 ltpclo

# Start bundle protocol engine
s
## end bpadmin

## begin ipnadmin
# Add egress plans (node 2 uses TCP, node 3 uses TCP, node 1 uses LTP)
a plan 2 tcp/10.1.1.2:4556
a plan 3 tcp/10.1.1.3:4556
a plan 1 ltp/1
## end ipnadmin

FILE: host3.rc (3-node network)

## Run the following command to start ION node:
##  % ionstart -I "host3.rc"

## begin ionadmin
# Initialize node 3 with default SDR configuration
1 3 ""
s

# Add contacts for 3-node network (topology: 1--2--3)
a contact +1 +3600 1 1 100000
a contact +1 +3600 1 2 100000
a contact +1 +3600 2 1 100000
a contact +1 +3600 2 2 100000
a contact +1 +3600 2 3 100000
a contact +1 +3600 3 2 100000
a contact +1 +3600 3 3 100000

# Add ranges (1 sec OWLT for neighbors, 2 sec for node 1 to 3)
a range +1 +3600 1 1 1
a range +1 +3600 1 2 1
a range +1 +3600 1 3 2
a range +1 +3600 2 2 1
a range +1 +3600 2 3 1
a range +1 +3600 3 3 1

# Set production and consumption rates
m production 1000000
m consumption 1000000
## end ionadmin

## begin bpadmin
# Initialize BP
1

# Add IPN scheme
a scheme ipn 'ipnfw' 'ipnadminep'

# Add endpoints (discard behavior 'x')
a endpoint ipn:3.0 x
a endpoint ipn:3.1 x
a endpoint ipn:3.2 x

# Add TCP protocol (1400 byte payload, 100 byte overhead)
a protocol tcp 1400 100

# Add TCP induct (listen on port 4556)
a induct tcp 10.1.1.3:4556 tcpcli

# Add TCP outducts (to self and host2)
a outduct tcp 10.1.1.3:4556 tcpclo
a outduct tcp 10.1.1.2:4556 tcpclo

# Start bundle protocol engine
s
## end bpadmin

## begin ipnadmin
# Add egress plans for nodes 3 and 2
a plan 3 tcp/10.1.1.3:4556
a plan 2 tcp/10.1.1.2:4556

# Add group route: send bundles for node 1 via node 2 (gateway)
a group 1 1 ipn:2.0
## end ipnadmin

Accessing ION Open-Source Code Repository

Releases

Use the Summary or the Files tab to download point releases

Using the code repository

There are two ways to obtain ION source code:

Option 1: Download ZIP file (Recommended for most users)

Visit the ION-DTN GitHub releases page: https://github.com/nasa-jpl/ION-DTN/releases
Find the desired release version (e.g., ion-open-source-4.1.4)
Click on "Assets" to expand the download options
Download the source code archive:
Source code (zip) for ZIP format
Source code (tar.gz) for compressed tarball format

Extract the downloaded archive:

# For ZIP file:
unzip ION-DTN-<version>.zip
cd ION-DTN-<version>

# For tar.gz file:
tar -xzf ION-DTN-<version>.tar.gz
cd ION-DTN-<version>

Proceed with the build instructions in Installing ION on Linux, MacOS, Solaris

Option 2: Clone the Git repository

For developers who want to track the latest development or contribute to ION:

# Clone the repository
git clone https://github.com/nasa-jpl/ION-DTN.git
cd ION-DTN

# Checkout a specific release tag (optional)
git checkout ion-open-source-4.1.4

# Or checkout a branch
git checkout integration  # For alpha/beta releases
git checkout current      # For stable releases

Branch Information: - Track the tags for alpha, beta, and stable releases - Stable releases are on the current branch - Alpha and beta releases are on integration branch

Open Source Development and Support

Please see the Open Source Development and Support document for details on governance of ION software development and ION support levels.

Updated IPN-URI Format Support (ION 4.1.4-a.2)

Starting with ION 4.1.4-a.2, ION has been updated to support the new IPN URI scheme defined in RFC 9758 as a alpha release feature. The new format is as follows:

ipn-uri = "ipn:" [allocator-identifier "."] node-number "." service-number

allocator-identifier: An unsigned integer identifying the allocation authority. If the authority is the default (IANA, Allocator ID 0), this part and the following dot (.) may be omitted for brevity. ION is backward compatible with IPN URIs that omit the allocator identifier, which is interpreted as having the default value of 0.

For all examples in this tutorial, the allocator identifier is omitted and defaults to 0.

New IPN URI support is under alpha testing.