freeswan/doc/manpage.d/ipsec_setup.8.html

   1 Content-type: text/html
   2
   3 <HTML><HEAD><TITLE>Manpage of IPSEC_SETUP</TITLE>
   4 </HEAD><BODY>
   5 <H1>IPSEC_SETUP</H1>
   6 Section: Maintenance Commands (8)<BR>Updated: 7 June 2001<BR><A HREF="#index">Index</A>
   7 <A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
   8
   9
  10 <A NAME="lbAB">&nbsp;</A>
  11 <H2>NAME</H2>
  12
  13 ipsec setup - control IPsec subsystem
  14 <A NAME="lbAC">&nbsp;</A>
  15 <H2>SYNOPSIS</H2>
  16
  17 <B>ipsec</B>
  18
  19 <B>setup</B>
  20
  21 command
  22 <A NAME="lbAD">&nbsp;</A>
  23 <H2>DESCRIPTION</H2>
  24
  25 <I>Setup</I>
  26
  27 controls the FreeS/WAN IPsec subsystem,
  28 including both the Klips kernel code and the Pluto key-negotiation daemon.
  29 (It is a synonym for the ``rc'' script for the subsystem;
  30 the system runs the equivalent of
  31 <B>ipsec setup start</B>
  32
  33 at boot time,
  34 and
  35 <B>ipsec setup stop</B>
  36
  37 at shutdown time, more or less.)
  38 <P>
  39
  40 The action taken depends on the specific
  41 <I>command</I>,
  42
  43 and on the contents of the
  44 <B>config</B>
  45
  46 <B>setup</B>
  47
  48 section of the
  49 IPsec configuration file (<I>/etc/ipsec.conf</I>,
  50
  51 see
  52 <I><A HREF="ipsec.conf.5.html">ipsec.conf</A></I>(5)).
  53
  54 Current
  55 <I>command</I>s
  56
  57 are:
  58 <DL COMPACT>
  59 <DT><B>start</B>
  60
  61 <DD>
  62 start Klips and Pluto,
  63 including setting up Klips to do crypto operations on the
  64 interface(s) specified in the configuration file,
  65 and (if the configuration file so specifies)
  66 setting up manually-keyed connections and/or
  67 asking Pluto to negotiate automatically-keyed connections
  68 to other security gateways
  69 <DT><B>stop</B>
  70
  71 <DD>
  72 shut down Klips and Pluto,
  73 including tearing down all existing crypto connections
  74 <DT><B>restart</B>
  75
  76 <DD>
  77 equivalent to
  78 <B>stop</B>
  79
  80 followed by
  81 <B>start</B>
  82
  83 <DT><B>status</B>
  84
  85 <DD>
  86 report the status of the subsystem;
  87 normally just reports
  88 <B>IPsec running</B>
  89
  90 and
  91 <B>pluto pid </B><I>nnn</I>,
  92
  93 or
  94 <B>IPsec stopped</B>,
  95
  96 and exits with status 0,
  97 but will go into more detail (and exit with status 1)
  98 if something strange is found.
  99 </DL>
 100 <P>
 101
 102 The
 103 <B>stop</B>
 104
 105 operation tries to clean up properly even if assorted accidents
 106 have occurred,
 107 e.g. Pluto having died without removing its lock file.
 108 If
 109 <B>stop</B>
 110
 111 discovers that the subsystem is (supposedly) not running,
 112 it will complain,
 113 but will do its cleanup anyway before exiting with status 1.
 114 <P>
 115
 116 Although a number of configuration-file parameters influence
 117 <I>setup</I>'s
 118
 119 operations, the key one is the
 120 <B>interfaces</B>
 121
 122 parameter, which must be right or chaos will ensue.
 123 <A NAME="lbAE">&nbsp;</A>
 124 <H2>FILES</H2>
 125
 126
 127
 128 /etc/rc.d/init.d/ipsec<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>the script itself<BR>
 129 <BR>
 130
 131 /etc/init.d/ipsec<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>alternate location for the script<BR>
 132 <BR>
 133
 134 /etc/ipsec.conf<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>IPsec configuration file<BR>
 135 <BR>
 136
 137 /var/run/ipsec.info<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>saved information<BR>
 138 <BR>
 139
 140 /proc/sys/net/ipv4/ip_forward<TT>&nbsp;</TT>forwarding control<BR>
 141 <A NAME="lbAF">&nbsp;</A>
 142 <H2>SEE ALSO</H2>
 143
 144 <A HREF="ipsec.conf.5.html">ipsec.conf</A>(5), <A HREF="ipsec.8.html">ipsec</A>(8), <A HREF="ipsec_manual.8.html">ipsec_manual</A>(8), <A HREF="ipsec_auto.8.html">ipsec_auto</A>(8), <A HREF="route.8.html">route</A>(8)
 145 <A NAME="lbAG">&nbsp;</A>
 146 <H2>DIAGNOSTICS</H2>
 147
 148 All output from the commands
 149 <B>start</B>
 150
 151 and
 152 <B>stop</B>
 153
 154 goes both to standard
 155 output and to
 156 <I><A HREF="syslogd.8.html">syslogd</A></I>(8),
 157
 158 via
 159 <I><A HREF="logger.1.html">logger</A></I>(1).
 160
 161 Selected additional information is logged only to
 162 <I><A HREF="syslogd.8.html">syslogd</A></I>(8).
 163
 164 <A NAME="lbAH">&nbsp;</A>
 165 <H2>HISTORY</H2>
 166
 167 Written for the FreeS/WAN project
 168 &lt;<A HREF="http://www.freeswan.org">http://www.freeswan.org</A>&gt;
 169 by Henry Spencer.
 170 <A NAME="lbAI">&nbsp;</A>
 171 <H2>BUGS</H2>
 172
 173 Old versions of
 174 <I><A HREF="logger.1.html">logger</A></I>(1)
 175
 176 inject spurious extra newlines onto standard output.
 177 <P>
 178
 179 <HR>
 180 <A NAME="index">&nbsp;</A><H2>Index</H2>
 181 <DL>
 182 <DT><A HREF="#lbAB">NAME</A><DD>
 183 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 184 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
 185 <DT><A HREF="#lbAE">FILES</A><DD>
 186 <DT><A HREF="#lbAF">SEE ALSO</A><DD>
 187 <DT><A HREF="#lbAG">DIAGNOSTICS</A><DD>
 188 <DT><A HREF="#lbAH">HISTORY</A><DD>
 189 <DT><A HREF="#lbAI">BUGS</A><DD>
 190 </DL>
 191 <HR>
 192 This document was created by
 193 <A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
 194 using the manual pages.<BR>
 195 Time: 05:09:33 GMT, June 19, 2001
 196 </BODY>
 197 </HTML>