close
Warning:
Failed to sync with repository "ogBrowser-Git": (1366, "Incorrect string value: '\\xF0\\x9F\\x93\\xA6 I...' for column 'message' at row 1"); repository information may be out of date. Look in the Trac log for more information including mitigation strategies.
- Timestamp:
-
Apr 8, 2016, 8:37:13 AM (11 years ago)
- Author:
-
ramon
- Comment:
-
Actualización de la definición del API REST
Legend:
- Unmodified
- Added
- Removed
- Modified
-
|
v5
|
v6
|
|
| 66 | 66 | Nota: Las rutas que se indican son relativas a la URL de la API REST y los identificadores variables se preceden del carácter "{{{:}}}". |
| 67 | 67 | |
| | 68 | ==== Rutas generales ==== |
| | 69 | |
| 68 | 70 | - {{{/login}}} |
| 69 | 71 | - Autenticación de usuario. |
| … |
… |
|
| 92 | 94 | - {{{description}}} (cadena): descripción de la UO. |
| 93 | 95 | |
| 94 | | - {{{/ous/:id1/rooms}}} |
| | 96 | - {{{/ous/:id1/labs}}} |
| 95 | 97 | - Listar las aulas definidas en la UO ''id1''. |
| 96 | 98 | - Método: GET. |
| 97 | 99 | - Deveulve: |
| 98 | 100 | - {{{ouid}}} (entero): identificador de la UO. |
| 99 | | - {{{rooms}}} (array): datos de las aulas definidas, compuesta por: |
| 100 | | - {{{roomid}}} (entero): identificador del aula. |
| 101 | | - {{{roomname}}} (cadena): nombre del aula. |
| 102 | | |
| 103 | | - {{{/ous/:id1/rooms/:id2}}} |
| | 101 | - {{{labs}}} (array): datos de las aulas definidas, compuesta por: |
| | 102 | - {{{labid}}} (entero): identificador del aula. |
| | 103 | - {{{labname}}} (cadena): nombre del aula. |
| | 104 | - {{{inremotepc}}} (booleano): indica si los recursos del aula están disponibles para el Proyecto Remote PC. |
| | 105 | |
| | 106 | - {{{/ous/:id1/labs/:id2}}} |
| 104 | 107 | - Obtener los datos del aula con identificador ''id2'' de la UO ''id1''. |
| 105 | 108 | - Método: GET. |
| 106 | 109 | - Devuelve: |
| 107 | | - {{{roomid}}} (entero): identificador del aula. |
| 108 | | - {{{roomname}}} (cadena): nombre del aula. |
| | 110 | - {{{labid}}} (entero): identificador del aula. |
| | 111 | - {{{labname}}} (cadena): nombre del aula. |
| 109 | 112 | - {{{description}}} (cadena): descripción del aula. |
| 110 | | - {{{inremotepc}}} (booleano): indica si los recursos del aula están disponible para el Proyecto Remote PC. |
| | 113 | - {{{inremotepc}}} (booleano): indica si los recursos del aula están disponibles para el Proyecto Remote PC. |
| 111 | 114 | - {{{maxclients}}} (entero): nº máximo de clientes del aula. |
| 112 | 115 | - {{{defclients}}} (entero): nº de clientes definidos en el aula. |
| … |
… |
|
| 115 | 118 | - {{{routerip}}} (cadena): dirección IP del router del aula. |
| 116 | 119 | - {{{netmask}}} (cadena): dirección IP de la máscara de red común a los clinetes del aula. |
| | 120 | - {{{ntp}}} (cadena): dirección IP del servidor NTP del aula. |
| 117 | 121 | - {{{dns}}} (cadena): dirección IP del servidor DNS principal para el aula. |
| 118 | 122 | - {{{proxyurl}}} (cadena): URL del servidor proxy del aula. |
| … |
… |
|
| 124 | 128 | - {{{p2ptime}}} (entero): tiempo de conexión tras finalizar la recepción P2P (en s.). |
| 125 | 129 | |
| 126 | | - {{{/ous/:id1/rooms/:id2/clients}}} |
| | 130 | - {{{/ous/:id1/labs/:id2/clients}}} |
| 127 | 131 | - Listar los clientes definidos en el aula ''id2'' de la UO ''id1''. |
| 128 | 132 | - Método: GET. |
| 129 | 133 | - Devuelve: |
| 130 | 134 | - {{{ouid}}} (entero): identificador de la UO. |
| 131 | | - {{{roomid}}} (entero): identificador del aula. |
| | 135 | - {{{labid}}} (entero): identificador del aula. |
| 132 | 136 | - {{{clients}}} (array): datos de los clientes definidas, compuesta por: |
| 133 | 137 | - {{{clientid}}} (entero): identificador del cliente. |
| 134 | 138 | - {{{clientname}}} (cadena): nombre del cliente. |
| 135 | 139 | |
| 136 | | - {{{/ous/:id1/rooms/:id2/clients/:id3}}} |
| | 140 | - {{{/ous/:id1/labs/:id2/clients/:id3}}} |
| 137 | 141 | - Obtener los datos del cliente con identificador ''id3'' del aula ''id2'' de la UO ''id1''. |
| 138 | 142 | - Método: GET. |
| … |
… |
|
| 142 | 146 | - {{{netiface}}} (cadena): interfaz de red por defecto. |
| 143 | 147 | - {{{netdriver}}} (cadena): driver (módulo a cargar) del interfaz de red (si {{{"generic"}}}, no se necesita cargar nada). |
| 144 | | - {{{macaddress}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":"). |
| 145 | | - {{{ipaddress}}} (cadena): dirección IP del cliente. |
| | 148 | - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":"). |
| | 149 | - {{{ip}}} (cadena): dirección IP del cliente. |
| 146 | 150 | - {{{netmask}}} (cadena): máscara de red. |
| 147 | 151 | - {{{routerip}}} (cadena): dirección IP del router por defecto. |
| 148 | 152 | - {{{repoid}}} (cadena): identificador del repositorio de imágenes. |
| | 153 | - Otros datos que pueden incluirse: |
| 149 | 154 | - {{{boottype}}} (cadena): plantilla asociada para el arranque del equipo. |
| 150 | | - Otros datos que pueden incluirse: |
| 151 | 155 | - {{{hardprofid}}} (entero): identificador del perfil de hardware del cliente. |
| 152 | 156 | - {{{menuid}}} (entero): identificador del menú de inicio del cliente. |
| 153 | 157 | - {{{validation}}} (booleano): indica si se necesita autenticación para entrar en el menú del cliente. |
| 154 | 158 | |
| 155 | | - {{{/ous/:id1/rooms/:id2/clients/:id3/hardware}}} |
| | 159 | - {{{/ous/:id1/labs/:id2/clients/:id3/hardware}}} |
| 156 | 160 | - Obtener los datos del perfil de hardware con la lista de dispoistivos del cliente con identificador ''id3'' del aula ''id2'' de la UO ''id1''. |
| 157 | 161 | - Método: GET. |
| … |
… |
|
| 163 | 167 | - {{{description}}} (cadena): descripción del componente. |
| 164 | 168 | |
| 165 | | - {{{/ous/:id1/rooms/:id2/clients/:id3/diskcfg}}} |
| | 169 | - {{{/ous/:id1/labs/:id2/clients/:id3/diskcfg}}} |
| 166 | 170 | - Obtener los datos de configuración e instalación de discos del cliente con identificador ''id3'' del aula |
| 167 | 171 | - Método: GET. |
| … |
… |
|
| 180 | 184 | - {{{filesystem}}} (cadena): nemónico del tipo de sistema de ficheros. |
| 181 | 185 | - {{{os}}} (cadena): sistema operativo instalado. |
| 182 | | - {{{idimage}}} (cadena): identificador de la imagen desplegada. |
| | 186 | - {{{imageid}}} (cadena): identificador de la imagen desplegada. |
| 183 | 187 | - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen (formato AAAA-MM-DD HH:MM:SS). |
| 184 | | |
| 185 | | - {{{/ous/:id1/rooms/:id2/clients/:id3/status}}} |
| | 188 | - Otros datos previstos que pueden incluirse: |
| | 189 | - {{{updated}}} (boolean): indica si la imagen desplegada está actualizada a la última versión del repositorio. |
| | 190 | - {{{cachedada}}} (string): información sobre la caché local. |
| | 191 | |
| | 192 | - {{{/ous/:id1/labs/:id2/clients/:id3/status}}} |
| 186 | 193 | - Obtener el de inicio del cliente con identificador ''id3'' del aula |
| 187 | 194 | - Método: GET. |
| … |
… |
|
| 192 | 199 | - Otros datos que pueden incluirse: |
| 193 | 200 | - {{{clientname}}} (cadena): nombre del cliente. |
| | 201 | - {{{loggedin}}} (boolean): indica si un usuario tiene una sesión abierta en un sistema operativo (solo si usa OGAgent). |
| 194 | 202 | |
| 195 | 203 | - {{{/ous/:id1/repos}}} |
| … |
… |
|
| 210 | 218 | - {{{description}}} (cadena): descripción del repositorio. |
| 211 | 219 | - {{{ipaddress}}} (cadena): dirección IP del repositorio. |
| 212 | | - {{{port}}} (entero): puerto de conexión al servicio del repositorio. |
| | 220 | - Otros datos que pueden incluirse: |
| | 221 | - {{{port}}} (entero): puerto de conexión al servicio del repositorio ogAdmRepo. |
| 213 | 222 | |
| 214 | 223 | - {{{/ous/:id1/images}}} |
| … |
… |
|
| 220 | 229 | - {{{imageid}}} (entero): identificador de la imagen. |
| 221 | 230 | - {{{imagename}}} (cadena): nombre de la imagen. |
| | 231 | - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC. |
| 222 | 232 | |
| 223 | 233 | - {{{/ous/:id1/images/:id2}}} |
| … |
… |
|
| 230 | 240 | - {{{description}}} (cadena): descripción de la imagen. |
| 231 | 241 | - {{{comments}}} (cadena): comentarios acerca de de la imagen. |
| | 242 | - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC. |
| 232 | 243 | - {{{type}}} (cadena): tipo de imagen ({{{"monolithic"}}}, {{{"base"}}} o {{{"incremental"}}}). |
| 233 | 244 | - Datos incluidos si la imagen es de tipo incremental: |
| … |
… |
|
| 241 | 252 | - Otros datos que pueden incluirse: |
| 242 | 253 | - {{{baseid}}} (entero): identificador de la imagen base para una imagen incremental. |
| | 254 | - {{{imagerelease}}} (cadena): revisión actual de la imagen. |
| 243 | 255 | |
| 244 | 256 | - {{{/ous/:id1/images/:id2/software}}} |
| … |
… |
|
| 252 | 264 | |
| 253 | 265 | - {{{/ous/:id1/images/:id2/boot}}} |
| 254 | | - Iniciar sesión en el sistema operativo de clientes que tengan instalada la imagen con identificador ''id2'' de la UO ''id1''. |
| 255 | | - Parámetros: |
| 256 | | - {{{nclients}}} (entero): nº de clientes a iniciar. |
| 257 | | - Método: POST. |
| | 266 | - Iniciar sesión en el sistema operativo de un cliente elegido al azar y que tenga instalada la imagen con identificador ''id2'' de la UO ''id1''. |
| | 267 | - Método: GET. |
| 258 | 268 | - Devuelve: (por determinar) |
| 259 | 269 | - {{{sendto}}} (array): datos de los clientes a los que se les ha enviado la orden de iniciar sesión, compuesta por: |
| 260 | 270 | - {{{clientid}}} (entero): identificador del cliente. |
| | 271 | - {{{ip}}} (cadena): dirección IP del cliente. |
| | 272 | - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":"). |
| 261 | 273 | - Otros datos que pueden incluirse en la lista de clientes: |
| 262 | 274 | - {{{clientname}}} (cadena): nombre del cliente. |
| 263 | | - {{{ip}}} (cadena): dirección IP del cliente. |
| | 275 | |
| | 276 | |
| | 277 | ==== Rutas para OGAgent ==== |
| | 278 | |
| | 279 | Rutas que atienden las notificaciones ''push'' de agentes OGAgent: |
| | 280 | |
| | 281 | - {{{/ogagent/started}}} |
| | 282 | - Notificación de que se ha iniciado el servicio OGAgent en un cliente. |
| | 283 | - Método: POST. |
| | 284 | - Parámetros: |
| | 285 | - {{{ip}}} (cadena): dirección IP del cliente. |
| | 286 | - {{{mac}}} (cadena): dirección MAC de la interfaz de red. |
| | 287 | |
| | 288 | - {{{/ogagent/stopped}}} |
| | 289 | - Notificación de que se ha detenido el servicio OGAgent en un cliente. |
| | 290 | - Método: POST. |
| | 291 | - Parámetros: |
| | 292 | - {{{ip}}} (cadena): dirección IP del cliente. |
| | 293 | - {{{mac}}} (cadena): dirección MAC de la interfaz de red. |
| | 294 | |
| | 295 | - {{{/ogagent/loggedin}}} |
| | 296 | - Notificación de que un usuario ha iniciado una sesión de escritorio en un cliente. |
| | 297 | - Método: POST. |
| | 298 | - Parámetros: |
| | 299 | - {{{ip}}} (cadena): dirección IP del cliente. |
| | 300 | - {{{user}}} (cadena): usuario que inicia la sesión. |
| | 301 | |
| | 302 | - {{{/ogagent/loggedout}}} |
| | 303 | - Notificación de que un usuario ha finalizado una sesión de escritorio en un cliente. |
| | 304 | - Método: POST. |
| | 305 | - Parámetros: |
| | 306 | - {{{ip}}} (cadena): dirección IP del cliente. |
| | 307 | - {{{user}}} (cadena): usuario que cierra la sesión. |