Documentation > Userspace Clients > bib Mode

bib Mode


  1. Description
  2. Syntax
  3. Arguments
    1. display
    2. add
    3. remove
    4. Flags
    5. Transport addresses
  4. Examples


Interacts with Jool’s Binding Information Base.


jool bib (
	display  [PROTOCOL] [--numeric] [--csv] [--no-headers]
	| add    [PROTOCOL] <IPv4-transport-address> <IPv6-transport-address>
	| remove [PROTOCOL] <IPv4-transport-address> <IPv6-transport-address>

PROTOCOL := --tcp | --udp | --icmp

../images/warning.svg Warning: Jool 3’s PROTOCOL label used to be defined as [--tcp] [--udp] [--icmp]. The flags are mutually exclusive now, and default to --tcp.



The BIB table that corresponds to the PROTOCOL protocol is printed in standard output.


Combines <IPv4-transport-address> and <IPv6-transport-address> into a static BIB entry, and uploads it to the BIB table that corresponds to the PROTOCOL protocol.

Note that the [<IPv4-transport-address>, PROTOCOL] tuple must be a member of Jool’s IPv4 pool, so make sure you have registered it there first.


Deletes the BIB entry described by <IPv4-transport-address> and/or <IPv6-transport-address> from the table that corresponds to the PROTOCOL protocol. The entry is not required to be static to be manually removed.

Since both transport addresses are unique within a table, you are allowed to omit one of them during removals.


Flag Description
--tcp Operate on the TCP table. This is the default protocol.
--udp Operate on the UDP table.
--icmp Operate on the ICMP table.
--numeric By default, display will attempt to resolve the names of the IPv6 transport addresses of each BIB entry. If your nameservers aren’t answering, this will pepper standard error with messages and slow the operation down.
Use --numeric to disable the lookups.
--csv Print the table in Comma/Character-Separated Values format. This is intended to be redirected into a .csv file.
--no-headers Print the table entries only; omit the headers.

Transport addresses

In TCP and UDP, a “transport address” is an union between an IP address and port. The format is “<IP address>#<port>”.

In ICMP, a “transport address” is an union between an IP address and an ICMP identifier. The format is “<IP address>#<ICMP identifier>”.



  • belongs to the IPv4 pool.
  • The name of 2001:db8::6 is “”.
  • 2001:db8::6 already spoke to an IPv4 node recently (so the database will be slightly populated in the beginning.)

Display the TCP table:

user@T:~# jool bib display
[Dynamic] -

Publish a couple of TCP services:

user@T:~# jool bib add 2001:db8::6#6  --tcp
user@T:~# jool bib add 2001:db8::6#66 --tcp

Display the TCP table again:

user@T:~# jool bib display --tcp
[Static] -
[Static] -
[Dynamic] -

Same, but do not query the DNS:

user@T:~# jool bib display --tcp --numeric
[Static] - 2001:db8::6#6
[Static] - 2001:db8::6#66
[Dynamic] - 2001:db8::6#1234

Dump the TCP table on a CSV file:

user@T:~# jool bib display --tcp --numeric --csv > bib-tcp.csv


Publish a UDP service:

user@T:~# jool bib add 2001:db8::6#6666 --udp

Remove the UDP entry:

user@T:~# jool bib remove --udp 2001:db8::6#6666