Changes between Version 8 and Version 9 of ApiRest

Timestamp:

Feb 2, 2017, 1:31:23 PM (7 years ago)

Author:

ramon

Comment:

Actualización documentación API REST.

ApiRest

@@ -117 +117 @@
 
  - {{{/ous/:id1/groups}}}
-   '''(documentar)'''
+   ''(documentar)''
 
  - {{{/ous/:id1/labs}}}
@@ -338 +338 @@
 
 
-==== Rutas para UDS ====
-
- - {{{/ous/:id1/images/:id2/reserve}}}
-   ''(documentar)
+==== Rutas para Remote PC ====
+
+Las siguientes rutas REST serán utilizadas por un servidor UDS para controlar procesos de iniciación y parada de clientes que tengan instalada una imagen en particular. El servidor OpenGnsys actuará como intermediario entre el servidor de UDS y los agentes OGAgent instalados en los sistemas operativos que podrán usarse en remoto.
+
+'''Notas de implementación:'''
+ - Se tendrán que hacer modificaciones en la BD para almacenar datos de reserva de equipos y de sesión de usuarios.
+ - Sería recomendable modificar el proceso de restauración para incluir en el SO datos de la imagen desplegada.
+ - Puede ser necesario crear un proceso de revisión cronológica de ejecución de acciones.
+ - Será necesario crear un script personalizado de inicio para arrancar un cliente en una partición determinada, el cual tendrá que ser eliminado tras su ejecución o trascurrido en tiempo determinado.
+ - Estudiar la manera de reintentar el envío de peticiones fallidas.
+
+ - {{{/ous/:id1/images/:id2/reserve}}} o {{{/ous/:id1/images/:id2/reserve?lab=:id3}}}
+   - Elegir al azar un cliente que tenga instalada una imagen (y, opcionalmente, que esté situado en una determinada aula), reservar su uso para acceso remoto y enviarle una operación de arranque en la partición de dicha imagen (o de reinicio, si el cliente está encendido).
+   - Método: GET.
+   - Parámetros:
+     - {{{lab}}} (intero): identificador del aula del cliente (opcional).
+   - Devuelve: objeto
+     - {{{id}}} (entero): identificador del cliente seleccionado.
+     - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
+     - {{{ip}}} (cadena): dirección IP del cliente.
+     - {{{ou}}} (objeto): OU a la que pertenecen.
+       - {{{id}}} (entero): identificador de la UO.
+     - {{{lab}}} (objeto): aula a la que pertenecen.
+       - {{{id}}} (entero): identificador de la UO.
 
  - {{{/ous/:id1/images/:id2/events}}}
-   ''(documentar)
+   - Registrar URLs para redirigir a un servidor UDS aquellas notificaciones ''push'' enviadas por un agente OGAgent de un cliente reservado para acceso remoto.
+   - Método: POST.
+   - Parámetros:
+     - {{{urllogin}}} (cadena): URL para redirigir una notificación de inicio de sesión de usuario.
+     - {{{urllogout}}} (cadena): URL para redirigir una notificación de fin de sesión de usuario.
 
  - {{{/ous/:id1/images/:id2/session}}}
-   ''(documentar)
+   - Registrar parámetros específicos de la sesión del usuario enviados por un servidor UDS.
+   - Método: POST.
+   - Parámetros:
+     - {{{poweroffAt}}} (cadena): hora para enviar una operación de apagado del cliente.
 
  - {{{/ous/:id1/images/:id2/unreserve}}}
-   ''(documentar)
+   - Liberar un cliente marcado para acceso remoto, borrando sus datos de registro y enviando una operación de apagado.
+   - Método: GET.
+