--- name: "jool" section: "8" platform: "linux" package: "jool-tools" version: "4.1.13-1.1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/jool" --- # jool(8) Interact with NAT64 Jool (the kernel module). ## NAME jool - Interact with NAT64 Jool (the kernel module). ## DESCRIPTION Sends commands and requests to NAT64 Jool.\ NAT64 Jool is a kernel module you load into a Linux kernel. It implements RFC 6146. ## AVAILABILITY Linux is the only OS in which this program makes sense.\ Kernels 5.15 and up. ## SYNTAX jool \[*\*\] instance (\ \ display\ \ \[--csv\]\ \ \[--no-headers\]\ \ \| add\ *\[\\]*\ \ (--netfilter \| --iptables)\ \--pool6 *\*\ \ \| remove\ *\[\\]*\ \ \| flush\ ) jool \[*\*\] stats (\ \ display\ \ \[--csv\]\ \ \[--no-headers\]\ \ \[--all\]\ \ \[--explain\]\ ) jool \[*\*\] global (\ \ display\ \ \[--csv\]\ \ \[--no-headers\]\ \ \| update\ *\ \*\ ) jool \[*\*\] pool4 (\ \ display\ \ \[--csv\]\ \ \[--no-headers\]\ \ \[--tcp \| --udp \| --icmp\]\ \ \| add\ *\ \*\ \ \[--tcp \| --udp \| --icmp\]\ \[--mark *\*\]\ \[--max-iterations (auto \| infinity \| *\*)\]\ \ \[--force\]\ \ \| remove\ *\ \*\ \ \[--tcp \| --udp \| --icmp\]\ \[--mark *\*\]\ \ \[--quick\]\ \ \| flush\ \ \[--quick\]\ ) jool \[*\*\] bib (\ \ display\ \ \[--csv\]\ \ \[--no-headers\]\ \ \[--tcp \| --udp \| --icmp\]\ \ \[--numeric\]\ \ \| add\ *\*\ *\*\ \ \[--tcp \| --udp \| --icmp\]\ \ \| remove\ *\[\\]*\ *\[\\]*\ \ \[--tcp \| --udp \| --icmp\]\ ) jool \[*\*\] session (\ \ display\ \ \[--csv\]\ \ \[--no-headers\]\ \ \[--tcp \| --udp \| --icmp\]\ \ \[--numeric\]\ \ \| follow\ \ \| proxy\ \ \[--net.dev.in=\\]\ \ \[--net.dev.out=\\]\ \ \[--net.mcast.port=\\]\ \ \[--stats.address=\\]\ \ \[--stats.port=\\]\ \ \[--net.ttl=\\]\ \ \\ \ \| advertise\ ) jool \[*\*\] file (\ handle *\*\ ) *\* := (--instance *\* \| --file *\*) ## OPTIONS ### Modes and Operations - instance display Show all instances from all namespaces. - instance add Create a new instance. - instance remove Drop an existing instance. - instance flush Drop all instances from the current namespace. - stats display Show internal counters. - global display Show the current values of the instance's tweakable internal variables. - global update Tweak one of the instance's internal variables. - pool4 display Show one of the tables from the IPv4 transport address pool.\ (Each protocol has one table.) - pool4 add Upload an entry to the IPv4 transport address pool. - pool4 remove Drop transport addresses from the IPv4 transport address pool. - pool4 flush Empty the IPv4 transport address pool. - bib display Show one of the BIB tables.\ (Each protocol has one table.) - bib add Add a static entry to the BIB. - bib remove Remove an entry (static or otherwise) from the BIB. - session display Show one of the the session tables.\ (Each protocol has one table.) - session follow Listen to the instance's sessions (whenever they are updated) forever, printing them in standard output.\ The instance must have ss-enabled=1. - session proxy Listen to sessions forever, exchanging them between the instance and other listening proxies.\ The -i instance must have ss-enabled=1. - session advertise Requests the instance to send its entire session table to listening followers and proxies. - file handle Parse all the configuration from a JSON file.\ Create instance if it doesn't exist, update if it does. ### Flags - \--instance \ Name of the instance you want to interact with.\ It's an ASCII string, 15 characters max. Defaults to 'default'. - \--file \ JSON file which contains the name of the instance you want to interact with.\ Same JSON structure as the one from atomic configuration. - \--tcp Apply the operation on the TCP table.\ (This is the default table.) - \--udp Apply the operation on the UDP table. - \--icmp Apply the operation on the ICMP table. - \--csv Output in CSV table format. - \--no-headers Do not print table headers. (Nor footer, if applies.) - \--netfilter Sit the instance on top of the Netfilter framework. - \--iptables Sit the instance on top of the iptables framework. - \--pool6 \ Contents of the new instance's IPv6 pool.\ The format is 'PREFIX\_ADDRESS\[/PREFIX\_LENGTH\]'. - \--all Show all the counters.\ (Otherwise, only the nonzero ones are printed.) - \--explain Show a description of each counter. - \--mark \ The pool4 entry will only be allowed to mask packets carrying this mark.\ It's a 32-bit unsigned integer. Defaults to zero. - \--max-iterations (auto \| infinity \| \) Maximum number of times the mask-finding algorithm will be allowed to iterate.\ *auto* computes a recommended default,\ *infinity* removes the iteration cap,\ *\* (unsigned 32-bit integer) sets the actual number. - \--force Apply operation even if certain validations fail. - \--quick Do not remove orphaned BIB and session entries. - \--numeric Do not query the DNS. ### Other Arguments - \ \ Name of the variable you want to edit (see 'Globals' section), and its new value. - \ \ Descriptor of the range of transport addresses you want to add or remove from the pool.\ \ is a range of ports; it should follow the format '\\[-\\]'.\ The command will add or remove addresses \#\ to \#\. - \, \ Transport addresses that shape the BIB entry you want to add or remove.\ The format is 'IPV6\_ADDRESS#PORT' and 'IPV4\_ADDRESS#PORT', respectively. - \ Name of the instance you want to add or remove.\ If --instance or --file were included in \, then the instance names must match. - \ Path to a JSON file. - \ Address SS traffic will be sent to and listened from. - \ UDP port where SS traffic will be sent to and listened from. - \ Address or interface to bind the socket in.\ If *\* is IPv4, this should be one addresses from the interface where the SS traffic is expected to be received. If *\* is IPv6, this should be the name of the interface (eg. *eth0*). - \ If *\* is IPv4, this should be one addresses from the interface where the multicast traffic is expected to be sent. If *\* is IPv6, this should be the name of the interface (eg. *eth0*). - \ Same as *IP\_MULTICAST\_TTL*, from *[ip(7)](/ip/7.md)*. - \ Address for (optional) statistics server. - \ Port for the *\* server. ### Globals - manually-enabled \ Enable or disable the instance. - pool6 \ The IPv6 pool's prefix.\ The format is 'PREFIX\_ADDRESS\[/PREFIX\_LENGTH\]'. - lowest-ipv6-mtu \ Smallest reachable IPv6 MTU. - logging-debug \ Enable logging of debug messages? - zeroize-traffic-class \ Always set the IPv6 header's 'Traffic Class' field as zero?\ Otherwise copy from IPv4 header's 'TOS'. - override-tos \ Override the IPv4 header's 'TOS' field as --tos?\ Otherwise copy from IPv6 header's 'Traffic Class'. - tos \ Value to override TOS as (only when override-tos is ON) - mtu-plateaus \ Set the list of plateaus for ICMPv4 Fragmentation Neededs with MTU unset. - address-dependent-filtering \ Behave as (address-)restricted-cone NAT?\ Otherwise behave as full-cone NAT. - drop-icmpv6-info \ Filter ICMPv6 Informational packets? - drop-externally-initiated-tcp \ Drop externally initiated TCP connections? - tcp-est-timeout \ Set the TCP established session lifetime. - tcp-trans-timeout \ Set the TCP transitory session lifetime. - udp-timeout \ Set the UDP session lifetime. - icmp-timeout \ Set the ICMP session lifetime. - maximum-simultaneous-opens \ Set the maximum allowable 'simultaneous' Simultaneos Opens of TCP connections. - source-icmpv6-errors-better \ Translate source addresses directly on 4-to-6 ICMP errors? - f-args \ Defines the arguments that will be sent to F().\ (F() is defined by algorithm 3 of RFC 6056.)\ \- First (leftmost) bit is source address.\ \- Second bit is source port.\ \- Third bit is destination address.\ \- Fourth (rightmost) bit is destination port. - handle-rst-during-fin-rcv \ Use transitory timer when RST is received during the V6 FIN RCV or V4 FIN RCV states? - logging-bib \ Log BIBs as they are created and destroyed? - logging-session \ Log sessions as they are created and destroyed? - trace \ Log basic packet fields as they are received? - ss-enabled \ Enable Session Synchronization? - ss-flush-asap \ Try to synchronize sessions as soon as possible? - ss-flush-deadline \ Inactive milliseconds after which to force a session sync. - ss-capacity \ Maximim number of queuable entries. - ss-max-payload \ Maximum amount of bytes joold should send per packet. ## EXAMPLES Create a new instance named "Example":\ \ jool instance add Example --iptables --pool6 64:ff9b::/96 Add addresses 192.0.2.10#1024 to 192.0.2.10#2048 to the IPv4/TCP pool:\ \ jool -i Example pool4 add 192.0.2.10 1024-2048 --tcp Print the TCP table of the BIB:\ \ jool -i Example bib display Add an UDP binding to the BIB:\ \ jool -i Example bib add 192.0.2.10#2000 1::1#2000 --tcp Remove the binding from the BIB:\ \ jool -i Example bib remove 192.0.2.10#2000 --tcp Print the TCP session table:\ \ jool -i Example session display Print the global configuration values:\ \ jool -i Example global display Update some global configuration value:\ \ jool -i Example global update address-dependent-filtering ON ## NOTES TRUE, FALSE, 1, 0, YES, NO, ON and OFF are all valid booleans. You can mix case too. ## EXIT STATUS Zero on success, non-zero on failure. ## AUTHOR NIC Mexico & ITESM ## REPORTING BUGS https://github.com/NICMx/Jool/issues ## COPYRIGHT Copyright 2024 NIC Mexico.\ License: GPLv2 (GNU GPL version 2)\ This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. ## SEE ALSO https://nicmx.github.io/Jool\ https://nicmx.github.io/Jool/en/documentation.html