#ESPECIFICACION DEL PROTOCOLO DEL PYMIN

[PARAMETROS OPCIONALES]
<PARAMETROS OBLIGATORIOS>

----------------------------------

MODULO : DHCP

para inciar/parar el servicio :
dhcp start
dhcp stop

para setear parametros:
dhcp set <PARAMETER> <VALUE>
PARAMETER puede tomar los siguientes valores :
domain_name : nombre de dominio
dns_1 : dominio del dns primario
dns_2 : dominio del dns secundario
net_address : direccion de red
net_mask : mascara de la direccion de red
net_start : direccion de inicio del rango
net_end : direccion de fin del rango
net_gateway : direccion del gateway

para crear un host:
dhcp host add <NAME> <IP> <MAC>
para eliminar un host:
dhcp host delete <NAME>


NAME : es el nombre del host
IP : la direccion ip del host
MAC : la direccion mac del host

-----------------------------------

MODULO : DNS

para inciar/parar el servicio :
dns start
dns stop

para setear parametros:
dns set <PARAMETER> <VALUE>
PARAMETER puede tomar los siguientes valores :
isp_dns1 : dns primario del isp
isp_dns2 : dns secundario del isp
bind_addr1 : direccion primaria a la cual bindear
bind_addr2 : direccion secundaria a la cual bindear

para crear una zona:
dns zone add <ZONE>

para eliminar una zona:
dns zone delete <ZONE>

para agregar un host a una zona:
dns host add <ZONE> <HOSTNAME> <IP_HOST>

para eliminar un host de una zona:
dns host delete <ZONE> <HOSTNAME>

para agregar un mail exchanger:
dns mx add <ZONE> <MAILEXCHANGER> <PRIO>

para eliminar un mail exchanger:
dns mx delete <ZONE> <MAILEXCHANGER>

para agregar un name server:
dns ns add <ZONE> <NAMESERVER>

para eliminar un name server:
dns ns delete <ZONE> <NAMESERVER>

ZONE : es el nombre de la zona a crear (ej : mizona.com)
HOSTNAME : nombre del host
IP_HOST : ip del host
MAILEXCHANGER : es un mail exchanger (ej: mx1.mizona.com)
PRIO : es la prioridad sobre el mail exchanger
NAMESERVER : es un name server (ej: ns1.mizona.com)

-----------------------------------

MODULO : IP

para levantar un device :
ip dev up <DEVICE>

para bajar un device :
ip dev down <DEVICE>

para agregar una direccion ip :
ip addr add <DEVICE> <IP> <PREFIX> [BROADCAST]

para eliminar una direccion ip :
ip addr add <DEVICE> <IP>

para ver las direcciones ip asignadas a un device:
ip addr show <DEVICE>

para agregar una ruta :
ip route add <NETADDR> <PREFIX> <GATEWAY> [DEVICE]

para eliminar una ruta:
ip route delete <ROUTEINDEX> [DEVICE]

para ver las rutas asignadas:
ip route show [DEVICE]
ACLARACION : si una ruta fue dada de alta sin especificar un device,
la misma podra verse con "ip route show", caso contrario hay
que especificar el device

para agregar un hop:
ip hop add <GATEWAY> <DEVICE>

para eliminar un hop:
ip hop delete <GATEWAY> <DEVICE>

para ver los hops :
ip hop show <DEVICE>


DEVICE : el device (ej: eth0)
IP : direccion ip
PREFIX : prefijo de la direccion ip
BROADCAST : direccion de broadcast (ocpional)
NETADDR : direccion de red
GATEWAY : direccion del gateway
ROUTEINDEX : es el indice de la lista que muestra el comando show

---------------------------------

MODULO : PPP

para inciar/parar el servicio :
ppp start
ppp stop

para agregar un coneccion :
ppp conn add <NAME> <USERNAME> <PASSWORD> <TYPE> [device=<DEVICE>] [server=<SERVER>]

para eliminar una coneccion :
ppp conn delete <NAME>

para mostrar las conecciones:
ppp show

NAME : npmbre de la coneccion
USERNAME : nombre de usuario
PASSWORD : contraseña
TYPE : tipo de coneccion punto a punto, la misma puede ser :
	OE : para pppoe , en este caso debera especificarse un device
	TUNNEL : para ppptp , en este caso debera especificarse un server
	PPP : para ppp , en este caso debera especificarse un device

---------------------------------

MODULO : PROXY

para inciar/parar el servicio :
proxy start
proxy stop

para setear parametros:
proxy set <PARAMETER> <VALUE>
PARAMETER puede tomar los siguientes valores :
ip : direccion ip
port : puerto en donde se esucucha

para agregar un host:
proxy host add <IP>

para eliminar un host:
proxy host delete <IP>

para ver los hosts:
proxy host show

para agregar un user:
proxy user add <USERNAME> <PASSWORD>

para eliminar un user:
proxy user add <USERNAME>

para ver los usuarios:
proxy user show

IP: la direccion ip del host
USERNAME : nombre de usuario
PASSWORD : contraseña

---------------------------------

MODULO : VRRP

para inciar/parar el servicio :
vrrp start
vrrp stop

para setear parametros:
vrrp set <PARAMETER> <VALUE>
PARAMETER puede tomar los siguientes valores :
ipaddress : direccion ip
id : id dentro del grupo
prio : prioridad router
dev : device

---------------------------------

MODULO : FIREWALL

para iniciar/parar el servicio:
firewall start
firewall stop
(el stop elimina todas las reglas y deja todo abierto)

Para agregar una regla:
firewall rule add <CHAIN> <TARGET> [<SRC> <DST> <PROTOCOL> <SRC_PORT> <DST_PORT>]
<CHAIN> puede ser: INPUT, OUTPUT o FORWARD
<TARGET> puede ser: ACCEPT, REJECT o DROP
<SRC> es la subred fuente (de la forma IP/máscara)
<DST> es la subred destino (de la forma IP/máscara)
<PROTOCOL> es: ICMP, UDP, TCP o ALL
<SRC_PORT> es el puerto fuente (solo válido si <PROTOCOL> es UDP o TCP)
<DST_PORT> es el puerto destino (solo válido si <PROTOCOL> es UDP o TCP)

Para modificar una regla:
firewall rule update <INDEX> [<CHAIN> <TARGET> <SRC> <DST> <PROTOCOL> <SRC_PORT> <DST_PORT>]
<INDEX> es la posición de la regla (puede verse con 'firewall rule show')
El resto de los parámetros son iguales que para agregar una regla.

Para borrar una regla:
firewall rule delete <INDEX>
<INDEX> es la posición de la regla (puede verse con 'firewall rule show')

Para borrar todas las reglas:
firewall rule clear

Para obtener información sobre una regla:
firewall rule get <INDEX>
<INDEX> es la posición de la regla (puede verse con 'firewall rule show')

Para listar (obtener sobre todas) las reglas:
firewall rule show

---------------------------------

MODULO : NAT

para iniciar/parar el servicio:
nat start
nat stop
(el stop elimina todas las reglas)

Para agregar una redirección de un puerto:
nat forward add <DEV> <PROTOCOL> <PORT> <DST> [<DST_PORT> <SRC_NET> <DST_NET>]
<DEV> es el dispositivo de red a usar (por ej eth1)
<PROTOCOL> es TCP o UDP
<PORT> es el puerto entrante a redireccionar
<DST> es la IP de destino a donde redireccionar el puerto
<DST_PORT> es el puerto destino (si no se especifica, es el mismo que <PORT>)
<SRC_NET> es la subred fuente para la cual aplicar le redireccionamiento (IP/máscara)
<DST_NET> es la subred destino para la cual aplicar le redireccionamiento (IP/máscara)
(si no se especifican subredes, se redirecciona todo el tráfico para el puerto)

Para modificar una redirección de un puerto:
nat forward update <INDEX> [<DEV> <PROTOCOL> <PORT> <DST> <DST_PORT> <SRC_NET> <DST_NET>]
<INDEX> es la posición de la redirección (puede verse con 'nat forward show')
El resto de los parámetros son iguales que para agregar una redirección.

Para borrar una redirección:
nat forward delete <INDEX>
<INDEX> es la posición de la redirección (puede verse con 'nat forward show')

Para borrar todas las redirecciones:
nat forward clear

Para obtener información sobre una redirección:
nat forward get <INDEX>
<INDEX> es la posición de la redirección (puede verse con 'nat forward show')

Para listar (obtener información sobre todas) las redirecciones:
nat forward show


Para agregar un source nat:
nat snat add <DEV> <SRC> [<SRC_NET>]
<DEV> es el dispositivo de red a usar (por ej eth1)
<SRC> dirección IP fuente a NATear
<SRC_NET> es la subred fuente para la cual aplicar el source nat (IP/máscara)
(si no se especifica subred, se redirecciona todo el tráfico de la IP fuente)

Para modificar un snat:
nat snat update <INDEX> [<DEV> <PROTOCOL> <PORT> <DST> <DST_PORT> <SRC_NET> <DST_NET>]
<INDEX> es la posición del snat (puede verse con 'nat snat show')
El resto de los parámetros son iguales que para agregar un snat.

Para borrar un snat:
nat snat delete <INDEX>
<INDEX> es la posición del snat (puede verse con 'nat snat show')

Para borrar todos los snat:
nat snat clear

Para obtener información sobre un snat:
nat snat get <INDEX>
<INDEX> es la posición del snat (puede verse con 'nat snat show')

Para listar (obtener información sobre todos) los snat:
nat snat show


Para agregar un enmascaramiento (masquerade):
nat masq add <DEV> <SRC_NET>
<DEV> es el dispositivo de red a usar (por ej eth1)
<SRC_NET> es la subred fuente para la cual aplicar el masq (IP/máscara)

Para modificar un masq:
nat masq update <INDEX> [<DEV> <DST_NET>]
<INDEX> es la posición del snat (puede verse con 'nat masq show')
El resto de los parámetros son iguales que para agregar un masq.

Para borrar un masq:
nat masq delete <INDEX>
<INDEX> es la posición del masq (puede verse con 'nat masq show')

Para borrar todos los masq:
nat masq clear

Para obtener información sobre un masq:
nat masq get <INDEX>
<INDEX> es la posición del masq (puede verse con 'nat masq show')

Para listar (obtener información sobre todos) los masq:
nat masq show