]>
Commit | Line | Data |
---|---|---|
0107b433 SS |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-zone-aiccu"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-aiccu</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Stefan</firstname> | |
14 | <surname>Schantl</surname> | |
15 | <email>stefan.schantl@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone-aiccu</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-aiccu</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
cf0fc8ab | 32 | <command>network zone new <replaceable>ZONE</replaceable> aiccu ...</command> |
0107b433 SS |
33 | </cmdsynopsis> |
34 | ||
35 | <cmdsynopsis> | |
36 | <command>network zone <replaceable>ZONE</replaceable> edit ...</command> | |
37 | </cmdsynopsis> | |
38 | </refsynopsisdiv> | |
39 | ||
40 | <refsect1> | |
41 | <title>Description</title> | |
42 | ||
43 | <para> | |
44 | The aiccu hook is used to create IPv6 tunnels over IPv4 networks | |
45 | when the provider does not provide native IPv6. | |
46 | </para> | |
47 | </refsect1> | |
48 | ||
49 | <refsect1> | |
50 | <title>Options</title> | |
51 | ||
52 | <para> | |
53 | The following options are understood: | |
54 | </para> | |
55 | ||
56 | <variablelist> | |
57 | <varlistentry> | |
58 | <term> | |
5bb66bbe | 59 | <option>--username=<replaceable>USERNAME</replaceable></option> |
0107b433 SS |
60 | </term> |
61 | ||
62 | <listitem> | |
63 | <para> | |
64 | The username of your account from the tunnel brocker. | |
65 | </para> | |
66 | </listitem> | |
67 | </varlistentry> | |
68 | ||
69 | <varlistentry> | |
70 | <term> | |
5bb66bbe | 71 | <option>--password=<replaceable>PASSWORD</replaceable></option> |
0107b433 SS |
72 | </term> |
73 | ||
74 | <listitem> | |
75 | <para> | |
76 | The password of your account from the tunnel brocker. | |
77 | </para> | |
78 | </listitem> | |
79 | </varlistentry> | |
80 | </variablelist> | |
81 | ||
82 | <para> | |
83 | Optional arguments, that can be used with aiccu. | |
84 | </para> | |
85 | ||
86 | <variablelist> | |
87 | <varlistentry> | |
88 | <term> | |
89 | <option>--server=<replaceable>STRING</replaceable></option> | |
90 | </term> | |
91 | ||
92 | <listitem> | |
93 | <para> | |
94 | The configuration server to use for setting up the tunnel. | |
95 | </para> | |
96 | ||
97 | <para> | |
98 | This option has to be set to the configuration server of your | |
99 | tunnel brocker. Defaults to <emphasis>tic.sixxs.net</emphasis>. | |
100 | </para> | |
101 | </listitem> | |
102 | </varlistentry> | |
103 | ||
104 | <varlistentry> | |
105 | <term> | |
106 | <option>--protocol=<replaceable>[<emphasis>tic</emphasis>|tsp|l2tp]</replaceable></option> | |
107 | </term> | |
108 | ||
109 | <listitem> | |
110 | <para> | |
111 | The used protocol to setup the tunnel. | |
112 | </para> | |
113 | ||
114 | <para> | |
115 | TIC is the Tunnel Information and Control protocol. It provides information | |
116 | about tunnels and the ability to control the details of a tunnel to TIC clients. | |
117 | </para> | |
118 | ||
119 | <para> | |
120 | The Tunnel Setup Protocol (TSP) is used to negotiate IP tunnel setup parameters | |
121 | between a tunnel client and a tunnel broker server. | |
122 | </para> | |
123 | ||
124 | <para> | |
125 | Layer 2 Tunneling Protocol (L2TP) is a tunneling protocol used to support virtual | |
126 | private networks (VPNs) or as part of the delivery of services by ISPs. | |
127 | </para> | |
128 | ||
129 | <para> | |
130 | This option defaults to <emphasis>tic</emphasis> and have | |
131 | to be changed if your tunnel brocker does not support that. | |
132 | </para> | |
133 | </listitem> | |
134 | </varlistentry> | |
135 | ||
136 | <varlistentry> | |
137 | <term> | |
138 | <option>--tunnel-id=<replaceable>N</replaceable></option> | |
139 | </term> | |
140 | ||
141 | <listitem> | |
142 | <para> | |
143 | The ID of this tunnel, given to you by your tunnel brocker. | |
144 | </para> | |
145 | ||
146 | <para> | |
147 | This option is only required when multiple tunnels have been requested. | |
148 | </para> | |
149 | </listitem> | |
150 | </varlistentry> | |
151 | ||
152 | <varlistentry> | |
153 | <term> | |
154 | <option>--require-tls=[<emphasis>true</emphasis>|false]</option> | |
155 | </term> | |
156 | ||
157 | <listitem> | |
158 | <para> | |
159 | Use STARTTLS to secure the connection to the configuration server. | |
160 | </para> | |
161 | ||
162 | <para> | |
163 | When set to true and the server does not support TLS, the transaction | |
164 | will fail. When set to false, it also tries a STARTTLS, but if this is | |
165 | not supported by the server, aiccu will continue and send the user and | |
166 | password information as plain text. | |
167 | </para> | |
168 | </listitem> | |
169 | </varlistentry> | |
170 | ||
171 | </variablelist> | |
172 | </refsect1> | |
173 | ||
174 | <refsect1> | |
175 | <title>See Also</title> | |
176 | ||
177 | <para> | |
178 | <citerefentry> | |
179 | <refentrytitle>network</refentrytitle> | |
180 | <manvolnum>8</manvolnum> | |
181 | </citerefentry>, | |
182 | <citerefentry> | |
183 | <refentrytitle>network-zone</refentrytitle> | |
184 | <manvolnum>8</manvolnum> | |
185 | </citerefentry> | |
186 | </para> | |
187 | </refsect1> | |
188 | </refentry> |