jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 1 | |
| 2 | .\" * OpenGGSN - Gateway GPRS Support Node |
| 3 | .\" * Copyright (C) 2002, 2003 Mondru AB. |
| 4 | .\" * |
| 5 | .\" * The contents of this file may be used under the terms of the GNU |
| 6 | .\" * General Public License Version 2, provided that the above copyright |
| 7 | .\" * notice and this permission notice is included in all copies or |
| 8 | .\" * substantial portions of the software. |
| 9 | .\" * |
| 10 | .\" * The initial developer of the original code is |
| 11 | .\" * Jens Jakobsen <jj@openggsn.org> |
| 12 | .\" * |
| 13 | .\" * Contributor(s): |
| 14 | .\" * |
| 15 | .\" Manual page for ggsn |
| 16 | .\" SH section heading |
| 17 | .\" SS subsection heading |
| 18 | .\" LP paragraph |
| 19 | .\" IP indented paragraph |
| 20 | .\" TP hanging label |
| 21 | |
| 22 | .TH ggsn 8 "July 2003" |
| 23 | .SH NAME |
| 24 | ggsn \- Gateway GPRS Support Node. |
| 25 | .SH SYNOPSIS |
| 26 | .B ggsn |
| 27 | \-\-help |
| 28 | |
| 29 | .B ggsn |
| 30 | \-\-version |
| 31 | |
| 32 | .B ggsn |
| 33 | [ |
| 34 | .BI \-\-fg |
| 35 | ] [ |
| 36 | .BI \-\-debug |
| 37 | ] [ |
| 38 | .BI \-\-conf " file" |
| 39 | ] [ |
| 40 | .BI \-\-pidfile " file" |
| 41 | ] [ |
| 42 | .BI \-\-statedir " file" |
| 43 | ] [ |
| 44 | .BI \-\-listen " host" |
| 45 | ] [ |
| 46 | .BI \-\-net " net" |
| 47 | ] [ |
| 48 | .BI \-\-ipup " script" |
| 49 | ] [ |
| 50 | .BI \-\-ipdown " script" |
| 51 | ] [ |
| 52 | .BI \-\-dynip " net" |
| 53 | ] [ |
| 54 | .BI \-\-statip " net" |
| 55 | ] [ |
| 56 | .BI \-\-pcodns1 " host" |
| 57 | ] [ |
| 58 | .BI \-\-pcodns2 " host" |
| 59 | ] [ |
| 60 | .BI \-\-timelimit " seconds" |
| 61 | ] |
| 62 | .SH DESCRIPTION |
| 63 | .B ggsn |
| 64 | is part of the |
| 65 | .B OpenGGSN |
| 66 | project, and implements a Gateway GPRS Support Node. It is used by |
| 67 | mobile operators as the interface between the Internet and the rest of |
| 68 | the mobile network infrastructure. |
| 69 | |
| 70 | The GPRS functionality and protocols has been standardised by the |
| 71 | Third Generation Partnership Project (3GPP). According to the 3GPP |
| 72 | specifications a GGSN has two interfaces: The Gn/Gp interface and the |
| 73 | Gi interface. |
| 74 | |
| 75 | The Gn/Gp interface can be seen as the downlink interface of the |
| 76 | GGSN. It is used for communicating with the Serving GPRS Support Node |
| 77 | (SGSN) which again interfaces to the radio access network. The Gn/Gp |
| 78 | interface uses the GPRS tunneling protocol (GTP). User data packets |
| 79 | (typically IP packets) are tunneled over GTP, which again uses UDP |
| 80 | over IP. |
| 81 | |
| 82 | The other interface can be thought of as the uplink interface, and |
| 83 | interfaces the GGSN to an external data network. Gi is most often an |
| 84 | interface to the Internet. |
| 85 | .B ggsn |
| 86 | uses the |
| 87 | .B TUN/TAP driver |
| 88 | for the Gi interface. A tun network interface is established when the |
| 89 | .B ggsn |
| 90 | is started. |
| 91 | |
| 92 | .B ggsn |
| 93 | will accept incoming connections from mobile stations through the |
| 94 | radio access network and the SGSN. When a connection request is |
| 95 | received the ggsn will allocate a dynamic IP address for the mobile |
| 96 | station, and allow the mobile station to access the Gi |
| 97 | interface. Connections are terminated by either the mobile station or |
Holger Hans Peter Freyther | 9c7fd8e | 2014-12-04 16:32:37 +0100 | [diff] [blame] | 98 | the SGSN. Runtime errors are reported using the Osmocom logging |
| 99 | framework. |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 100 | |
| 101 | Typically |
| 102 | .B ggsn |
| 103 | will be deployed with two Ethernet interfaces. One for the Gn/Gp |
| 104 | interface, and one for the Gi interface. Policy routing and firewall |
| 105 | rules should be used in order to separate Gi traffic from Gn/Gp |
| 106 | traffic. |
| 107 | |
| 108 | .SH OPTIONS |
| 109 | .TP |
| 110 | .BI --help |
| 111 | Print help and exit. |
| 112 | |
| 113 | .TP |
| 114 | .BI --version |
| 115 | Print version and exit. |
| 116 | |
| 117 | .TP |
| 118 | .BI --fg |
| 119 | Run in foreground (default = off) |
| 120 | |
| 121 | .TP |
| 122 | .BI --debug |
| 123 | Run in debug mode (default = off) |
| 124 | |
| 125 | .TP |
| 126 | .BI --conf " file" |
| 127 | Read configuration |
| 128 | .I file |
| 129 | (default = /etc/ggsn.conf) where each line corresponds to one command |
| 130 | line option, but with the leading '--' removed. Command line options |
| 131 | override the options given in the configuration file. |
| 132 | |
| 133 | .TP |
| 134 | .BI --pidfile " file" |
| 135 | Filename of process id |
| 136 | .I file |
| 137 | (default = /var/run/ggsn.pid) |
| 138 | |
| 139 | .TP |
| 140 | .BI --statedir " path" |
| 141 | .I path |
| 142 | to directory of nonvolatile data (default = /var/lib/ggsn/) |
| 143 | |
| 144 | .TP |
| 145 | .BI --listen " host" |
| 146 | Local interface IP address to use for the Gn/Gp interface. This option |
| 147 | must be specified. For security issues it is not possible to use |
| 148 | INADDR_ANY. |
| 149 | |
| 150 | .TP |
| 151 | .BI --net " net" |
| 152 | Network address of the Gi interface (default = 192.168.0.0/24). The |
| 153 | network address is set during initialisation when |
| 154 | .B ggsn |
| 155 | establishes a tun device for the Gi interface. |
| 156 | |
| 157 | .TP |
| 158 | .BI --ipup " script" |
| 159 | Script executed after the Gi tun network interface has been brought |
| 160 | up. Executed with the following parameters: <devicename> <ip address> |
| 161 | |
| 162 | .TP |
| 163 | .BI --ipdown " script" |
| 164 | Script executed after the Gi tun network interface has been taken |
| 165 | down. Executed with the following parameters: <devicename> <ip |
| 166 | address> |
| 167 | |
| 168 | .TP |
| 169 | .BI --dynip " net" |
| 170 | Dynamic IP address pool. Specifies a pool of dynamic IP addresses. If |
| 171 | this option is omitted the network address specified by the |
| 172 | .BI --net |
| 173 | option is used for dynamic IP address allocation. |
| 174 | |
| 175 | .TP |
| 176 | .BI --pcodns1 " host" |
| 177 | PCO DNS Server 1 (default = 0.0.0.0). PCO stands for Protocol |
| 178 | Configuration options, and is part of the GPRS protocols. It is used |
| 179 | to inform the mobile station about the DNS address to use for host |
| 180 | name resolution. |
| 181 | |
| 182 | .TP |
| 183 | .BI --pcodns2 " host" |
| 184 | PCO DNS Server 2 (default = 0.0.0.0). PCO stands for Protocol |
| 185 | Configuration options, and is part of the GPRS protocols. It is used |
| 186 | to inform the mobile station about the DNS address to use for host |
| 187 | name resolution. |
| 188 | |
| 189 | .TP |
| 190 | .BI --timelimit " seconds" |
| 191 | Exit |
| 192 | .b ggsn |
| 193 | after \fIseconds\fP. Used for debugging. |
| 194 | |
| 195 | |
| 196 | .SH FILES |
| 197 | .I /etc/ggsn.conf |
| 198 | .RS |
| 199 | The configuration file for |
| 200 | .B ggsn. |
| 201 | .RE |
| 202 | .I /var/run/ggsn.pid |
| 203 | .RS |
| 204 | Process ID file. |
| 205 | .RE |
| 206 | .I /var/lib/ggsn |
| 207 | .RS |
| 208 | Directory holding nonvolatile data. |
| 209 | .RE |
| 210 | |
| 211 | .SH BUGS |
| 212 | Report all bugs to the OpenGGSN bug tracking list at |
| 213 | .I http://sourceforge.net/projects/ggsn/ |
| 214 | |
| 215 | .B ggsn |
| 216 | has very limited management support. Currently both SNMP as well as |
| 217 | billing mechanisms are missing. |
| 218 | |
| 219 | |
| 220 | .SH "SEE ALSO" |
Holger Hans Peter Freyther | 9c7fd8e | 2014-12-04 16:32:37 +0100 | [diff] [blame] | 221 | .BR sgsnemu (8) |
jjako | d1afd81 | 2003-07-06 17:43:17 +0000 | [diff] [blame] | 222 | |
| 223 | .SH NOTES |
| 224 | .LP |
| 225 | |
| 226 | Besides the long options documented in this man page |
| 227 | .B ggsn |
| 228 | also accepts a number of short options with the same functionality. Use |
| 229 | .B ggsn --help |
| 230 | for a full list of all the available options. |
| 231 | |
| 232 | The TUN/TAP driver is required for proper operation of |
| 233 | .B ggsn. |
| 234 | For linux kernels later than 2.4.7 the TUN/TAP driver is included in the kernel, but typically needs to be loaded manually with |
| 235 | .B modprobe tun. |
| 236 | For automatic loading the line |
| 237 | .B alias char-major-10-200 tun |
| 238 | can be added to |
| 239 | .B /etc/modules.conf. |
| 240 | For other platforms see |
| 241 | .I http://vtun.sourceforge.net/tun/ |
| 242 | for information on how to install and configure the tun driver. |
| 243 | |
| 244 | .B ggsn |
| 245 | uses the GPRS Tunneling Protocol (GTP) as specified by the Third |
| 246 | Generation Partnership Project (3GPP). 3GPP protocols specifications |
| 247 | can be found at |
| 248 | .I http://www.3gpp.org |
| 249 | |
| 250 | .SH COPYRIGHT |
| 251 | |
| 252 | Copyright (C) 2002, 2003 by Mondru AB. |
| 253 | |
| 254 | The contents of this file may be used under the terms of the GNU |
| 255 | General Public License Version 2, provided that the above copyright |
| 256 | notice and this permission notice is included in all copies or |
| 257 | substantial portions of the software. |
| 258 | |
| 259 | .SH AUTHORS |
| 260 | Jens Jakobsen <jj@openggsn.org> |