man.rst 1.57 KB
Newer Older
sparrowhawk's avatar
sparrowhawk committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
cdist-type__jool(7)
===================

NAME
----
cdist-type__jool - Configures a NAT64 instance using jool.


DESCRIPTION
-----------
This type configures an instance of a NAT64 using jool. This type **does not**
configure anything related to the other capacities of the jool project, such as
SIIT (see the `jool_siit` daemon / `__jool_siit` type - unimplemented at this
time). See https://jool.mx

Note that this type is only implemented for the Alpine Linux operating system.

Note that this type currently does not implement running several parallel
instances of jool NAT64. Please contribute your implementation if you do so.


REQUIRED PARAMETERS
-------------------
None.


OPTIONAL PARAMETERS
-------------------
instance
    The instance name, `default` if unspecified.

framework
    The used translation framework, `netfilter` if unspecified.

pool6
    The IPv6 prefix used to map IPv4 addresses, `64:ff9b::/96` if unspecified.


EXAMPLES
--------

.. code-block:: sh

    __jool # Everything default

    # or, if you're feeling contrary

    __jool --instance "prettysoup" \
        --framework "iptables" \
        --pool6 "2001:DB8:dead:beef::/96"


SEE ALSO
--------
`cdist-type__jool_siit(7)` - yet to be written
`cdist-type__joold(7)` - yet to be written


AUTHORS
-------
Joachim Desroches <joachim.desroches@epfl.ch>


COPYING
-------
Copyright \(C) 2021 Joachim Desroches. You can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.