welterde/l2tpns
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update plugin docs

Browse source
This commit is contained in:
Brendan O'Dea 2005-06-28 15:21:49 +00:00
parent a685501f64
commit 6f7d8eb27f
1 changed files with 64 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

124
Docs/manual.html
View file

@ -822,14 +822,14 @@ supplied structure:
some way. some way.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
<LI>username</LI> <DT>username
<LI>password</LI> <DT>password
<LI>protocol (0xC023 for PAP, 0xC223 for CHAP)</LI> <DT>protocol<DD>0xC023 for PAP, 0xC223 for CHAP
<LI>continue_auth - Set to 0 to stop processing authentication modules</LI> <DT>continue_auth<DD>Set to 0 to stop processing authentication modules
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>post_auth</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>post_auth</B></TD>
@ -839,16 +839,16 @@ supplied structure:
to be accepted. to be accepted.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
<LI>username</LI> <DT>username
<LI>auth_allowed - This is already set to true or <DT>auth_allowed<DD>This is already set to true or
false depending on whether authentication has been false depending on whether authentication has been
allowed so far. You can set this to 1 or 0 to force allowed so far. You can set this to 1 or 0 to force
allow or disallow authentication</LI> allow or disallow authentication
<LI>protocol (0xC023 for PAP, 0xC223 for CHAP)</LI> <DT>protocol<DD>0xC023 for PAP, 0xC223 for CHAP
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>packet_rx</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>packet_rx</B></TD>
@ -857,12 +857,12 @@ supplied structure:
seriously slow down the system.</FONT> seriously slow down the system.</FONT>
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
<LI>buf - The raw packet data</LI> <DT>buf<DD>The raw packet data
<LI>len - The length of buf</LI> <DT>len<DD>The length of buf
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>packet_tx</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>packet_tx</B></TD>
@ -871,12 +871,12 @@ supplied structure:
seriously slow down the system.</FONT> seriously slow down the system.</FONT>
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
<LI>buf - The raw packet data</LI> <DT>buf<DD>The raw packet data
<LI>len - The length of buf</LI> <DT>len<DD>The length of buf
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>timer</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>timer</B></TD>
@ -885,9 +885,9 @@ supplied structure:
you do is reentrant. you do is reentrant.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>time_now - The current unix timestamp</LI> <DT>time_now<DD>The current unix timestamp
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>new_session</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>new_session</B></TD>
@ -895,10 +895,10 @@ supplied structure:
session is now ready to handle traffic. session is now ready to handle traffic.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>kill_session</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>kill_session</B></TD>
@ -906,10 +906,10 @@ supplied structure:
This may be called multiple times for the same session. This may be called multiple times for the same session.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
</UL> </DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>radius_response</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>radius_response</B></TD>
@ -919,12 +919,24 @@ supplied structure:
modules. modules.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>t - Tunnel ID</LI> <DT>t<DD>Tunnel
<LI>s - Session ID</LI> <DT>s<DD>Session
<LI>key</LI> <DT>key
<LI>value</LI> <DT>value
</UL> </DL>
</TD>
</TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>radius_reset</B></TD>
<TD>This is called whenever a RADIUS CoA request is
received to reset any options to default values before
the new values are applied.
</TD>
<TD>
<DL>
<DT>t<DD>Tunnel
<DT>s<DD>Session
</DL>
</TD> </TD>
</TR> </TR>
<TR VALIGN=TOP BGCOLOR=WHITE><TD><B>control</B></TD> <TR VALIGN=TOP BGCOLOR=WHITE><TD><B>control</B></TD>
@ -933,21 +945,13 @@ supplied structure:
required. required.
</TD> </TD>
<TD> <TD>
<UL> <DL>
<LI>buf - The raw packet data</LI> <DT>iam_master<DD>Cluster master status
<LI>l - The raw packet data length</LI> <DT>argc<DD>The number of arguments
<LI>source_ip - Where the request came from</LI> <DT>argv<DD>Arguments
<LI>source_port - Where the request came from</LI> <DT>response<DD>Return value: NSCTL_RES_OK or NSCTL_RES_ERR
<LI>response - Allocate a buffer and put your response in here</LI> <DT>additional<DD>Extended response text
<LI>response_length - Length of response</LI> </DL>
<LI>send_response - true or false whether a response
should be sent. If you set this to true, you must
allocate a response buffer.</LI>
<LI>type - Type of request (see nsctl.c)</LI>
<LI>id - ID of request</LI>
<LI>data - I'm really not sure</LI>
<LI>data_length - Length of data</LI>
</UL>
</TD> </TD>
</TR> </TR>
</TABLE> </TABLE>