jool(8) | NAT64 Jool's Userspace Client | jool(8) |
jool - Interact with NAT64 Jool (the kernel module).
Sends commands and requests to NAT64 Jool.
NAT64 Jool is a kernel module you load into a Linux kernel. It implements RFC
6146.
Linux is the only OS in which this program makes sense.
Kernels 3.13 and up.
jool [<argp1>] instance (
display
[--csv]
[--no-headers]
| add
[<Instance-Name>]
(--netfilter | --iptables)
--pool6 <IPv6-prefix>
| remove
[<Instance-Name>]
| flush
| <help>
)
jool [<argp1>] stats (
display
[--csv]
[--no-headers]
[--all]
[--explain]
| <help>
)
jool [<argp1>] global (
display
[--csv]
[--no-headers]
| update
<Key> <Value>
| <help>
)
jool [<argp1>] pool4 (
display
[--csv]
[--no-headers]
[--tcp | --udp | --icmp]
| add
<IPv4-Address> <Ports>
[--tcp | --udp | --icmp]
[--mark <Mark>]
[--max-iterations (auto | infinity | <Iterations>)]
[--force]
| remove
<IPv4-Address> <Ports>
[--tcp | --udp | --icmp]
[--mark <Mark>]
[--quick]
| flush
[--quick]
| <help>
)
jool [<argp1>] bib (
display
[--csv]
[--no-headers]
[--tcp | --udp | --icmp]
[--numeric]
| add
<IPv6-Transport-Address>
<IPv4-Transport-Address>
[--tcp | --udp | --icmp]
| remove
[<IPv6-Transport-Address>]
[<IPv4-Transport-Address>]
[--tcp | --udp | --icmp]
| <help>
)
jool [<argp1>] session (
display
[--csv]
[--no-headers]
[--tcp | --udp | --icmp]
[--numeric]
| <help>
)
jool [<argp1>] file (
handle <JSON-File>
| <help>
)
<argp1> := (<help> | --instance <Name> | --file <File>)
<help> := (--help | --usage | --version)
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
TRUE, FALSE, 1, 0, YES, NO, ON and OFF are all valid booleans. You can mix case too.
Zero on success, non-zero on failure.
NIC Mexico & ITESM
Our issue tracker is https://github.com/NICMx/Jool/issues. If you want to mail us instead, use jool@nic.mx.
Copyright 2021 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.
https://www.jool.mx
https://www.jool.mx/en/documentation.html
2021-02-19 | v4.1.5 |