From: Nicolas Emiliani <nemiliani@integratech.com.ar>
Date: Mon, 17 Dec 2007 19:30:18 +0000 (-0300)
Subject: Added the protocol specification.
X-Git-Url: https://git.llucax.com/software/pymin.git/commitdiff_plain/38ca58aee84b8ec5add6dc413196d08e2861a610?ds=sidebyside

Added the protocol specification.
---

diff --git a/doc/protocol_specification.txt b/doc/protocol_specification.txt
new file mode 100644
index 0000000..6d26d7e
--- /dev/null
+++ b/doc/protocol_specification.txt
@@ -0,0 +1,208 @@
+#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
+