doc/protocol_specification.txt

   1 #ESPECIFICACION DEL PROTOCOLO DEL PYMIN
   2
   3 [PARAMETROS OPCIONALES]
   4 <PARAMETROS OBLIGATORIOS>
   5
   6 ----------------------------------
   7
   8 MODULO : DHCP
   9
  10 para inciar/parar el servicio :
  11 dhcp start
  12 dhcp stop
  13
  14 para setear parametros:
  15 dhcp set <PARAMETER> <VALUE>
  16 PARAMETER puede tomar los siguientes valores :
  17 domain_name : nombre de dominio
  18 dns_1 : dominio del dns primario
  19 dns_2 : dominio del dns secundario
  20 net_address : direccion de red
  21 net_mask : mascara de la direccion de red
  22 net_start : direccion de inicio del rango
  23 net_end : direccion de fin del rango
  24 net_gateway : direccion del gateway
  25
  26 para crear un host:
  27 dhcp host add <NAME> <IP> <MAC>
  28 para eliminar un host:
  29 dhcp host delete <NAME>
  30
  31
  32 NAME : es el nombre del host
  33 IP : la direccion ip del host
  34 MAC : la direccion mac del host
  35
  36 -----------------------------------
  37
  38 MODULO : DNS
  39
  40 para inciar/parar el servicio :
  41 dns start
  42 dns stop
  43
  44 para setear parametros:
  45 dns set <PARAMETER> <VALUE>
  46 PARAMETER puede tomar los siguientes valores :
  47 isp_dns1 : dns primario del isp
  48 isp_dns2 : dns secundario del isp
  49 bind_addr1 : direccion primaria a la cual bindear
  50 bind_addr2 : direccion secundaria a la cual bindear
  51
  52 para crear una zona:
  53 dns zone add <ZONE>
  54
  55 para eliminar una zona:
  56 dns zone delete <ZONE>
  57
  58 para agregar un host a una zona:
  59 dns host add <ZONE> <HOSTNAME> <IP_HOST>
  60
  61 para eliminar un host de una zona:
  62 dns host delete <ZONE> <HOSTNAME>
  63
  64 para agregar un mail exchanger:
  65 dns mx add <ZONE> <MAILEXCHANGER> <PRIO>
  66
  67 para eliminar un mail exchanger:
  68 dns mx delete <ZONE> <MAILEXCHANGER>
  69
  70 para agregar un name server:
  71 dns ns add <ZONE> <NAMESERVER>
  72
  73 para eliminar un name server:
  74 dns ns delete <ZONE> <NAMESERVER>
  75
  76 ZONE : es el nombre de la zona a crear (ej : mizona.com)
  77 HOSTNAME : nombre del host
  78 IP_HOST : ip del host
  79 MAILEXCHANGER : es un mail exchanger (ej: mx1.mizona.com)
  80 PRIO : es la prioridad sobre el mail exchanger
  81 NAMESERVER : es un name server (ej: ns1.mizona.com)
  82
  83 -----------------------------------
  84
  85 MODULO : IP
  86
  87 para levantar un device :
  88 ip dev up <DEVICE>
  89
  90 para bajar un device :
  91 ip dev down <DEVICE>
  92
  93 para agregar una direccion ip :
  94 ip addr add <DEVICE> <IP> <PREFIX> [BROADCAST]
  95
  96 para eliminar una direccion ip :
  97 ip addr add <DEVICE> <IP>
  98
  99 para ver las direcciones ip asignadas a un device:
 100 ip addr show <DEVICE>
 101
 102 para agregar una ruta :
 103 ip route add <NETADDR> <PREFIX> <GATEWAY> [DEVICE]
 104
 105 para eliminar una ruta:
 106 ip route delete <ROUTEINDEX> [DEVICE]
 107
 108 para ver las rutas asignadas:
 109 ip route show [DEVICE]
 110 ACLARACION : si una ruta fue dada de alta sin especificar un device,
 111 la misma podra verse con "ip route show", caso contrario hay
 112 que especificar el device
 113
 114 para agregar un hop:
 115 ip hop add <GATEWAY> <DEVICE>
 116
 117 para eliminar un hop:
 118 ip hop delete <GATEWAY> <DEVICE>
 119
 120 para ver los hops :
 121 ip hop show <DEVICE>
 122
 123
 124 DEVICE : el device (ej: eth0)
 125 IP : direccion ip
 126 PREFIX : prefijo de la direccion ip
 127 BROADCAST : direccion de broadcast (ocpional)
 128 NETADDR : direccion de red
 129 GATEWAY : direccion del gateway
 130 ROUTEINDEX : es el indice de la lista que muestra el comando show
 131
 132 ---------------------------------
 133
 134 MODULO : PPP
 135
 136 para inciar/parar el servicio :
 137 ppp start
 138 ppp stop
 139
 140 para agregar un coneccion :
 141 ppp conn add <NAME> <USERNAME> <PASSWORD> <TYPE> [device=<DEVICE>] [server=<SERVER>]
 142
 143 para eliminar una coneccion :
 144 ppp conn delete <NAME>
 145
 146 para mostrar las conecciones:
 147 ppp show
 148
 149 NAME : npmbre de la coneccion
 150 USERNAME : nombre de usuario
 151 PASSWORD : contraseña
 152 TYPE : tipo de coneccion punto a punto, la misma puede ser :
 153         OE : para pppoe , en este caso debera especificarse un device
 154         TUNNEL : para ppptp , en este caso debera especificarse un server
 155         PPP : para ppp , en este caso debera especificarse un device
 156
 157 ---------------------------------
 158
 159 MODULO : PROXY
 160
 161 para inciar/parar el servicio :
 162 proxy start
 163 proxy stop
 164
 165 para setear parametros:
 166 proxy set <PARAMETER> <VALUE>
 167 PARAMETER puede tomar los siguientes valores :
 168 ip : direccion ip
 169 port : puerto en donde se esucucha
 170
 171 para agregar un host:
 172 proxy host add <IP>
 173
 174 para eliminar un host:
 175 proxy host delete <IP>
 176
 177 para ver los hosts:
 178 proxy host show
 179
 180 para agregar un user:
 181 proxy user add <USERNAME> <PASSWORD>
 182
 183 para eliminar un user:
 184 proxy user add <USERNAME>
 185
 186 para ver los usuarios:
 187 proxy user show
 188
 189 IP: la direccion ip del host
 190 USERNAME : nombre de usuario
 191 PASSWORD : contraseña
 192
 193 ---------------------------------
 194
 195 MODULO : VRRP
 196
 197 para inciar/parar el servicio :
 198 vrrp start
 199 vrrp stop
 200
 201 para setear parametros:
 202 vrrp set <PARAMETER> <VALUE>
 203 PARAMETER puede tomar los siguientes valores :
 204 ipaddress : direccion ip
 205 id : id dentro del grupo
 206 prio : prioridad router
 207 dev : device
 208
 209 ---------------------------------
 210
 211 MODULO : FIREWALL
 212
 213 para iniciar/parar el servicio:
 214 firewall start
 215 firewall stop
 216 (el stop elimina todas las reglas y deja todo abierto)
 217
 218 Para agregar una regla:
 219 firewall rule add <CHAIN> <TARGET> [<SRC> <DST> <PROTOCOL> <SRC_PORT> <DST_PORT>]
 220 <CHAIN> puede ser: INPUT, OUTPUT o FORWARD
 221 <TARGET> puede ser: ACCEPT, REJECT o DROP
 222 <SRC> es la subred fuente (de la forma IP/máscara)
 223 <DST> es la subred destino (de la forma IP/máscara)
 224 <PROTOCOL> es: ICMP, UDP, TCP o ALL
 225 <SRC_PORT> es el puerto fuente (solo válido si <PROTOCOL> es UDP o TCP)
 226 <DST_PORT> es el puerto destino (solo válido si <PROTOCOL> es UDP o TCP)
 227
 228 Para modificar una regla:
 229 firewall rule update <INDEX> [<CHAIN> <TARGET> <SRC> <DST> <PROTOCOL> <SRC_PORT> <DST_PORT>]
 230 <INDEX> es la posición de la regla (puede verse con 'firewall rule show')
 231 El resto de los parámetros son iguales que para agregar una regla.
 232
 233 Para borrar una regla:
 234 firewall rule delete <INDEX>
 235 <INDEX> es la posición de la regla (puede verse con 'firewall rule show')
 236
 237 Para borrar todas las reglas:
 238 firewall rule clear
 239
 240 Para obtener información sobre una regla:
 241 firewall rule get <INDEX>
 242 <INDEX> es la posición de la regla (puede verse con 'firewall rule show')
 243
 244 Para listar (obtener sobre todas) las reglas:
 245 firewall rule show
 246
 247 ---------------------------------
 248
 249 MODULO : NAT
 250
 251 para iniciar/parar el servicio:
 252 nat start
 253 nat stop
 254 (el stop elimina todas las reglas)
 255
 256 Para agregar una redirección de un puerto:
 257 nat forward add <DEV> <PROTOCOL> <PORT> <DST> [<DST_PORT> <SRC_NET> <DST_NET>]
 258 <DEV> es el dispositivo de red a usar (por ej eth1)
 259 <PROTOCOL> es TCP o UDP
 260 <PORT> es el puerto entrante a redireccionar
 261 <DST> es la IP de destino a donde redireccionar el puerto
 262 <DST_PORT> es el puerto destino (si no se especifica, es el mismo que <PORT>)
 263 <SRC_NET> es la subred fuente para la cual aplicar le redireccionamiento (IP/máscara)
 264 <DST_NET> es la subred destino para la cual aplicar le redireccionamiento (IP/máscara)
 265 (si no se especifican subredes, se redirecciona todo el tráfico para el puerto)
 266
 267 Para modificar una redirección de un puerto:
 268 nat forward update <INDEX> [<DEV> <PROTOCOL> <PORT> <DST> <DST_PORT> <SRC_NET> <DST_NET>]
 269 <INDEX> es la posición de la redirección (puede verse con 'nat forward show')
 270 El resto de los parámetros son iguales que para agregar una redirección.
 271
 272 Para borrar una redirección:
 273 nat forward delete <INDEX>
 274 <INDEX> es la posición de la redirección (puede verse con 'nat forward show')
 275
 276 Para borrar todas las redirecciones:
 277 nat forward clear
 278
 279 Para obtener información sobre una redirección:
 280 nat forward get <INDEX>
 281 <INDEX> es la posición de la redirección (puede verse con 'nat forward show')
 282
 283 Para listar (obtener información sobre todas) las redirecciones:
 284 nat forward show
 285
 286
 287 Para agregar un source nat:
 288 nat snat add <DEV> <SRC> [<SRC_NET>]
 289 <DEV> es el dispositivo de red a usar (por ej eth1)
 290 <SRC> dirección IP fuente a NATear
 291 <SRC_NET> es la subred fuente para la cual aplicar el source nat (IP/máscara)
 292 (si no se especifica subred, se redirecciona todo el tráfico de la IP fuente)
 293
 294 Para modificar un snat:
 295 nat snat update <INDEX> [<DEV> <PROTOCOL> <PORT> <DST> <DST_PORT> <SRC_NET> <DST_NET>]
 296 <INDEX> es la posición del snat (puede verse con 'nat snat show')
 297 El resto de los parámetros son iguales que para agregar un snat.
 298
 299 Para borrar un snat:
 300 nat snat delete <INDEX>
 301 <INDEX> es la posición del snat (puede verse con 'nat snat show')
 302
 303 Para borrar todos los snat:
 304 nat snat clear
 305
 306 Para obtener información sobre un snat:
 307 nat snat get <INDEX>
 308 <INDEX> es la posición del snat (puede verse con 'nat snat show')
 309
 310 Para listar (obtener información sobre todos) los snat:
 311 nat snat show
 312
 313
 314 Para agregar un enmascaramiento (masquerade):
 315 nat masq add <DEV> <SRC_NET>
 316 <DEV> es el dispositivo de red a usar (por ej eth1)
 317 <SRC_NET> es la subred fuente para la cual aplicar el masq (IP/máscara)
 318
 319 Para modificar un masq:
 320 nat masq update <INDEX> [<DEV> <DST_NET>]
 321 <INDEX> es la posición del snat (puede verse con 'nat masq show')
 322 El resto de los parámetros son iguales que para agregar un masq.
 323
 324 Para borrar un masq:
 325 nat masq delete <INDEX>
 326 <INDEX> es la posición del masq (puede verse con 'nat masq show')
 327
 328 Para borrar todos los masq:
 329 nat masq clear
 330
 331 Para obtener información sobre un masq:
 332 nat masq get <INDEX>
 333 <INDEX> es la posición del masq (puede verse con 'nat masq show')
 334
 335 Para listar (obtener información sobre todos) los masq:
 336 nat masq show
 337
 338
 339