refs #208 Adds new endpoints and documentate it
parent
300abccaca
commit
171120d350
463
README.md
463
README.md
|
@ -10,23 +10,26 @@ La API de Ogboot proporciona una interfaz para facilitar el proceso de inicializ
|
|||
El presente documento detalla los endpoints del API con sus respectivos parámetros de entrada así como las acciones que llevan a cabo
|
||||
|
||||
|
||||
|
||||
### Tabla de Contenido
|
||||
|
||||
1. [Obtener configuración de ogboot](#obtener-configuración-de-ogboot) - `/ogboot/config`
|
||||
2. [Mostrar información de todos los clientes ogLive instalados](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `/ogboot/clients/oglives`
|
||||
3. [Mostrar información del cliente ogLive predeterminado](#mostrar-información-del-cliente-oglive-predeterminado) - `/ogboot/clients/oglives/show-default`
|
||||
4. [Mostrar información de un cliente ogLive específico](#mostrar-información-de-un-cliente-oglive-específico) - `/ogboot/clients/oglives/show/{Index|Dir}`
|
||||
5. [Obtener todos los archivos de arranque](#obtener-todos-los-archivos-de-arranque) - `/ogboot/clients/pxes`
|
||||
6. [Obtener archivo de arranque](#obtener-archivo-de-arranque) - `/ogboot/clients/pxes/{mac}`
|
||||
7. [Crear archivo de arranque](#crear-archivo-de-arranque) - `/ogboot/clients/pxes`
|
||||
8. [Eliminar archivo de arranque](#eliminar-archivo-de-arranque) - `/ogboot/clients/pxes`
|
||||
9. [Actualizar repositorio de arranque](#actualizar-repositorio-de-arranque) - `/ogboot/clients/pxe/update-repo`
|
||||
10. [Mostrar menú de descarga de imagen de ogLive](#mostrar-menú-de-descarga-de-imagen-de-oglive) - `/ogboot/images/download`
|
||||
11. [Descargar imagen de ogLive específica](#descargar-imagen-de-oglive-específica) - `/images/download/{iso}`
|
||||
12. [Instalar nuevo cliente ogLive desde imagen descargada](#instalar-nuevo-cliente-oglive-desde-imagen-descargada) - `/ogboot/images/upload/{iso}`
|
||||
13. [Elimina cliente ogLive](#desinstalar-cliente-oglive-y-eliminar-imagen) - `/ogboot/images/remove/{iso}`
|
||||
|
||||
1. [Obtener configuración de ogboot](#obtener-configuración-de-ogboot) - `GET /ogboot/config`
|
||||
2. [Obtener datos de rendimiento](#obtener-datos-de-rendimiento) - `GET /ogboot/status`
|
||||
3. [Mostrar información de todos los clientes ogLive instalados](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `GET /ogboot/oglives`
|
||||
4. [Mostrar información de un cliente ogLive instalado](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `GET /ogboot/oglives/{Index|Dir}`
|
||||
5. [Mostrar información del cliente ogLive predeterminado](#mostrar-información-del-cliente-oglive-predeterminado) - `GET /ogboot/oglives/default`
|
||||
6. [Cambiar ogLive predeterminado](#cambiar-oglive-predeterminado) - `POST /ogboot/oglives/default/{Index}`
|
||||
7. [Instalar nuevo cliente ogLive desde imagen descargada](#instalar-nuevo-cliente-oglive-desde-imagen-descargada) - `POST /ogboot/oglive/{Index/iso}`
|
||||
8. [Desinstalar cliente ogLive y eliminar imagen](#desinstalar-cliente-oglive-y-eliminar-imagen) - `DELETE /ogboot/oglives/{Index/iso}`
|
||||
9. [Regenerar archivo de información de los ogLive](#regenerar-archivo-de-información-de-los-oglive) - `PUT /ogboot/oglives`
|
||||
10. [Mostrar menú de descarga de imagen de ogLive](#mostrar-menú-de-descarga-de-imagen-de-oglive) - `GET /ogboot/images/download`
|
||||
11. [Obtener todos los archivos de arranque](#obtener-todos-los-archivos-de-arranque) - `GET /ogboot/pxes`
|
||||
12. [Obtener archivo de arranque](#obtener-archivo-de-arranque) - `GET /ogboot/clients/pxes/{mac}`
|
||||
13. [Crear archivo de arranque](#crear-archivo-de-arranque) - `POST /ogboot/pxes`
|
||||
14. [Eliminar archivo de arranque](#eliminar-archivo-de-arranque) - `DELETE /ogboot/clients/pxes`
|
||||
15. [Obtener todas las plantillas](#obtener-todas-las-plantillas) - `GET /ogboot/pxe-templates`
|
||||
16. [Obtener contenido de la plantilla](#obtener-contenido-de-la-plantilla) - `GET /ogboot/pxe-templates/{nombre}`
|
||||
17. [Crear plantilla](#crear-plantilla) - `POST /ogboot/pxe-templates`
|
||||
18. [Regenerar plantilla](#regenerar-plantilla) - `PUT /ogboot/pxe-templates`
|
||||
|
||||
|
||||
### Obtener Configuración de ogboot
|
||||
|
@ -59,12 +62,40 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/config
|
|||
|
||||
|
||||
|
||||
### Obtener estado de ogboot
|
||||
|
||||
Devuelve la consistencia, errores de incompatibilidad y de configuración
|
||||
|
||||
**URL:** `/ogboot/status`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/status
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La status de ogboot se obtuvo exitosamente.
|
||||
- **Contenido:** .
|
||||
Some installed ogLive aren't fully compatible: , , ogLive-3.19.0-i386-r4795
|
||||
Problems detected:
|
||||
```
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. La status de ogboot no se ha obtenido correctamente.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Mostrar Información de Todos los Clientes ogLive Instalados
|
||||
|
||||
Muestra información en formato JSON sobre todos los clientes ogLive instalados.
|
||||
|
||||
**URL:** `/ogboot/clients/oglives/`
|
||||
**URL:** `/ogboot/clients/oglives`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
@ -96,18 +127,22 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/ogliv
|
|||
**Respuestas:**
|
||||
- **Código 200 OK:** La información sobre todos los clientes ogLive instalados se obtuvo exitosamente.
|
||||
- **Contenido:** Información sobre todos los clientes ogLive instalados en formato JSON.
|
||||
|
||||
|
||||
### Mostrar Información del Cliente ogLive Predeterminado
|
||||
### Mostrar Información de un Cliente ogLive Instalado
|
||||
|
||||
Muestra información en formato JSON sobre el cliente ogLive marcado como predeterminado.
|
||||
Muestra información en formato JSON sobre un cliente ogLive instalado específico.
|
||||
|
||||
**URL:** `/ogboot/clients/oglives/show-default`
|
||||
**URL:** `/ogboot/clients/oglives/{Index|Dir}`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{Index|Dir}`: El índice o directorio del cliente ogLive instalado.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/show-default
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/1
|
||||
|
||||
{
|
||||
"distribution": "focal",
|
||||
|
@ -117,125 +152,131 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/ogliv
|
|||
"directory": "ogLive-5.11.0-r20210413",
|
||||
"iso": "ogLive-focal-5.11.0-22-generic-amd64-r20210413.992ebb9.iso"
|
||||
}
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La información sobre el cliente ogLive instalado se obtuvo exitosamente.
|
||||
- **Contenido:** Información sobre el cliente ogLive instalado en formato JSON.
|
||||
- **Código 404 Not Found:** No se encontró ningún cliente ogLive instalado con el índice o directorio proporcionado.
|
||||
|
||||
### Mostrar Información del Cliente ogLive Predeterminado
|
||||
|
||||
Muestra información en formato JSON sobre el cliente ogLive predeterminado.
|
||||
|
||||
**URL:** `/ogboot/clients/oglives/default`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/default
|
||||
|
||||
{
|
||||
"distribution": "focal",
|
||||
"kernel": "5.11.0-22-generic",
|
||||
"architecture": "amd64",
|
||||
"revision": "r20210413",
|
||||
"directory": "ogLive-5.11.0-r20210413",
|
||||
"iso": "ogLive-focal-5.11.0-22-generic-amd64-r20210413.992ebb9.iso"
|
||||
}
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La información sobre el cliente ogLive predeterminado se obtuvo exitosamente.
|
||||
- **Contenido:** Información sobre el cliente ogLive predeterminado en formato JSON.
|
||||
|
||||
### Mostrar Información de un Cliente ogLive Específico
|
||||
|
||||
Muestra información en formato JSON sobre un cliente ogLive instalado específico, identificado por su índice o directorio.
|
||||
|
||||
**URL:** `/ogboot/clients/oglives/show/{Index|Dir}`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `Index|Dir`: Índice numérico o directorio del cliente ogLive.
|
||||
|
||||
### Cambiar ogLive Predeterminado
|
||||
|
||||
Establece un nuevo cliente ogLive como predeterminado utilizando su índice.
|
||||
|
||||
**URL:**
|
||||
**Método HTTP:** POST
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{Index}`: El índice del cliente ogLive que se establecerá como predeterminado.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/show/0
|
||||
|
||||
{
|
||||
"distribution": "focal",
|
||||
"kernel": "5.13.0-27-beta",
|
||||
"architecture": "amd64",
|
||||
"revision": "r20210706",
|
||||
"directory": "ogLive-5.13.0-r20210706",
|
||||
"iso": "ogLive-focal-5.13.0-27-beta-amd64-r20210706.5b4bf5f.iso"
|
||||
}
|
||||
|
||||
curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/default/1
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La información sobre el cliente ogLive específico se obtuvo exitosamente.
|
||||
- **Contenido:** Información sobre el cliente ogLive específico en formato JSON.
|
||||
- **Código 200 OK:** El cliente ogLive se estableció como predeterminado exitosamente.
|
||||
- **Código 404 Not Found:** No se encontró ningún cliente ogLive con el índice proporcionado.
|
||||
|
||||
|
||||
|
||||
### Obtener Todos los Archivos de Arranque
|
||||
### Descargar e Instalar Nuevo Cliente ogLive desde Imagen Descargada
|
||||
|
||||
Devuelve todos los archivos de arranque PXE y sus direcciones MAC asociadas.
|
||||
Descarga y luego instala un nuevo cliente ogLive utilizando la imagen descargada, especificada por su índice o nombre de archivo ISO.
|
||||
|
||||
**URL:** `/ogboot/clients/pxes`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La lista de archivos de arranque PXE se obtuvo exitosamente.
|
||||
- **Contenido:** Lista de archivos de arranque PXE con sus direcciones MAC asociadas.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. La lista de archivos de arranque PXE no se obtuvo correctamente.
|
||||
|
||||
|
||||
|
||||
### Obtener Archivo de Arranque
|
||||
|
||||
Devuelve el archivo de arranque PXE del ordenador con la dirección MAC correspondiente.
|
||||
|
||||
**URL:** `/ogboot/clients/pxes/{mac}`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Parámetros de ruta:**
|
||||
- `mac`: Dirección MAC del ordenador.
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El archivo de arranque PXE se obtuvo exitosamente.
|
||||
- **Contenido:** Archivo de arranque PXE en formato deseado.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. El archivo de arranque PXE no se obtuvo correctamente.
|
||||
|
||||
|
||||
|
||||
### Crear Archivo de Arranque
|
||||
|
||||
Crea un archivo de arranque PXE para el ordenador basado en la plantilla indicada.
|
||||
|
||||
**URL:** `/ogboot/clients/pxes`
|
||||
**URL:** `/ogboot/oglive/{Index/iso}`
|
||||
**Método HTTP:** POST
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `bootopt`: Plantilla de arranque PXE.
|
||||
- `hostname`: Nombre del ordenador.
|
||||
- `lang`: Idioma de arranque.
|
||||
**Parámetros de la URL:**
|
||||
- `{Index/iso}`: El índice o nombre de archivo ISO de la imagen ogLive que se utilizará para la descarga e instalación.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/oglive/1
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El archivo de arranque PXE se creó exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. El archivo de arranque PXE no se creó correctamente.
|
||||
- **Código 200 OK:** La descarga e instalación del nuevo cliente ogLive desde la imagen descargada fue exitosa.
|
||||
- **Código 404 Not Found:** No se encontró ninguna imagen ogLive con el índice o nombre de archivo ISO proporcionado.
|
||||
|
||||
### Eliminar Archivo de Arranque
|
||||
|
||||
Borra el archivo de arranque PXE del ordenador con la dirección MAC correspondiente.
|
||||
|
||||
**URL:** `/ogboot/clients/pxes`
|
||||
|
||||
### Desinstalar Cliente ogLive
|
||||
|
||||
Desinstala un cliente ogLive específico y elimina su imagen asociada.
|
||||
|
||||
**URL:** `/ogboot/oglives/{Index/iso}`
|
||||
**Método HTTP:** DELETE
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `mac`: Dirección MAC del ordenador.
|
||||
**Parámetros de la URL:**
|
||||
- `{Index/iso}`: El índice o nombre de archivo ISO del cliente ogLive que se desinstalará y eliminará.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/oglives/1
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El archivo de arranque PXE se eliminó exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. El archivo de arranque PXE no se eliminó correctamente.
|
||||
- **Código 200 OK:** El cliente ogLive se desinstaló y su imagen asociada se eliminó correctamente.
|
||||
- **Código 404 Not Found:** No se encontró ningún cliente ogLive con el índice o nombre de archivo ISO proporcionado.
|
||||
|
||||
|
||||
### Actualizar Repositorio de Arranque
|
||||
### Regenerar Archivo de Información de los ogLive
|
||||
|
||||
Actualiza la IP del repositorio en los archivos de arranque PXE de todos los equipos asociados.
|
||||
Regenera el archivo de información de los clientes ogLive instalados.
|
||||
|
||||
**URL:** `/ogboot/clients/pxe/update-repo`
|
||||
**Método HTTP:** POST
|
||||
**URL:** `/ogboot/oglives`
|
||||
**Método HTTP:** PUT
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `repoid`: Campo identificador del repositorio.
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/oglives
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La IP del repositorio se actualizó en los archivos de arranque PXE exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. La IP del repositorio no se actualizó correctamente.
|
||||
- **Código 200 OK:** El archivo de información de los clientes ogLive se regeneró correctamente.
|
||||
- **Código 500 Internal Server Error:** Ocurrió un error al intentar regenerar el archivo de información de los clientes ogLive.
|
||||
|
||||
|
||||
|
||||
### Mostrar Menú de Descarga de Imagen de ogLive
|
||||
|
||||
Muestra un menú para descargar una imagen de ogLive desde el sitio web de OpenGnsys.
|
||||
Muestra un menú con opciones para descargar imágenes de ogLive disponibles.
|
||||
|
||||
**URL:** `/ogboot/images/download`
|
||||
**Método HTTP:** GET
|
||||
|
@ -244,97 +285,221 @@ Muestra un menú para descargar una imagen de ogLive desde el sitio web de OpenG
|
|||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/images/download
|
||||
|
||||
Available downloads (+ = installed, * = full compatibility):
|
||||
1) (*) (+) ogLive-focal-5.13.0-27-beta-amd64-r20210706.5b4bf5f.iso
|
||||
2) (*) (+) ogLive-focal-5.11.0-22-generic-amd64-r20210413.992ebb9.iso
|
||||
3) (*) ogLive-focal-5.8.0-50-generic-amd64-r20210413.992ebb9.iso
|
||||
4) (*) ogLive-bionic-5.4.0-40-generic-amd64-r20200629.85eceaf.iso
|
||||
5) (*) ogLive-bionic-5.0.0-27-generic-amd64-r20190830.7208cc9.iso
|
||||
6) (*) ogLive-bionic-5.0.0-15-generic-amd64-r20190605.527cd97.iso
|
||||
7) ogLive-xenial-4.8.0-39-generic-amd64-r5652.iso
|
||||
8) ogLive-xenial-4.13.0-17-generic-amd64-r5520.iso
|
||||
9) ogLive-precise-3.2.0-23-generic-r5159.iso
|
||||
10) ogLive-xenial-4.8.0-39-generic-amd64-r5331.iso
|
||||
11) ogLive-xenial-4.8.0-39-generic-amd64-r5225.iso
|
||||
12) ogLive-precise-3.2.0-23-generic-r4820.iso
|
||||
13) ogLive-xenial-4.4.0-34-generic-r4999.iso
|
||||
14) ogLive-wily-4.2.0-35-generic-r4919.iso
|
||||
15) ogLive-vivid-3.19.0-49-generic-r4795.iso
|
||||
16) ogLive-precise-3.2.0-23-generic-r4311.iso
|
||||
17) ogLive-precise-3.11.0-26-generic-r4413.iso
|
||||
18) ogLive-raring-3.8.0-22-generic-r3836.iso
|
||||
19) ogLive-quantal-3.7.6-030706-generic-r3619.iso
|
||||
20) ogLive-precise-3.2.0-23-generic-r3257.iso
|
||||
21) ogLive-precise-3.2.0-23-generic-pae-r3017.iso
|
||||
22) ogLive-oneiric-3.0.0-14-generic-r2439.iso
|
||||
23) ogLive-natty-2.6.38-8-generic-pae-r2303.iso
|
||||
24) ogLive-natty-2.6.38-8-generic-pae-r2268.iso
|
||||
#?
|
||||
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El menú de descarga de la imagen de ogLive se muestra exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. El menú de descarga de la imagen de ogLive no se ha mostrado correctamente.
|
||||
- **Código 200 OK:** El menú de descarga de imágenes de ogLive se obtuvo exitosamente.
|
||||
- **Contenido:** Menú de descarga de imágenes de ogLive en formato JSON.
|
||||
|
||||
### Descargar Imagen de ogLive Específica
|
||||
|
||||
Descarga una imagen de ogLive específica desde el sitio web de OpenGnsys.
|
||||
|
||||
**URL:** `/ogboot/images/download/{iso}`
|
||||
### Obtener Todos los Archivos de Arranque
|
||||
|
||||
Obtiene una lista de todos los archivos de arranque disponibles.
|
||||
|
||||
**URL:** `/ogboot/pxes`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `iso`: Nombre de la imagen de ogLive a descargar.
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxes
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La lista de todos los archivos de arranque se obtuvo exitosamente.
|
||||
- **Contenido:** Lista de archivos de arranque en formato JSON.
|
||||
|
||||
|
||||
### Obtener Archivo de Arranque
|
||||
|
||||
Obtiene un archivo de arranque específico utilizando la dirección MAC del cliente.
|
||||
|
||||
**URL:** `/ogboot/clients/pxes/{mac}`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{mac}`: La dirección MAC del cliente cuyo archivo de arranque se desea obtener.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/images/download/ogLive-focal-5.13.0-27-beta-amd64-r20210706.5b4bf5f.iso
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/pxes/00:11:22:33:44:55
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La imagen de ogLive se descargó exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. La imagen de ogLive no se ha descargado correctamente.
|
||||
- **Código 200 OK:** El archivo de arranque para la dirección MAC especificada se encontró y se devuelve correctamente.
|
||||
- **Contenido:** El archivo de arranque en formato adecuado para su uso en el cliente correspondiente.
|
||||
- **Código 404 Not Found:** No se encontró ningún archivo de arranque para la dirección MAC especificada.
|
||||
|
||||
### Desplegar Nuevo Cliente ogLive desde Imagen Descargada
|
||||
|
||||
Despliega un nuevo cliente ogLive utilizando una imagen de ogLive previamente descargada.
|
||||
|
||||
**URL:** `/ogboot/images/upload/{iso}`
|
||||
### Crear Archivo de Arranque
|
||||
|
||||
Crea un nuevo archivo de arranque utilizando los parámetros proporcionados.
|
||||
|
||||
**URL:** `/ogboot/pxes`
|
||||
**Método HTTP:** POST
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `iso`: Nombre de la imagen de ogLive a instalar.
|
||||
**Cuerpo de la Solicitud:**
|
||||
- Datos necesarios para la creación del archivo de arranque, como el nombre, la configuración, etc.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/images/upload/ogLive-focal-5.13.0-27-beta-amd64-r20210706.5b4bf5f.iso
|
||||
curl -X POST -H "Authorization: $API_KEY" -d '{"name": "bootfile", "config": "some_configuration"}' http://example.com/ogboot/pxes
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El cliente ogLive se instaló exitosamente desde la imagen descargada.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. El cliente ogLive no se ha instalado correctamente.
|
||||
- **Código 200 OK:** El archivo de arranque se creó exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud.
|
||||
|
||||
### Desinstalar Cliente ogLive y Eliminar Imagen
|
||||
|
||||
Desinstala un cliente ogLive y elimina la imagen asociada.
|
||||
### Eliminar Archivo de Arranque
|
||||
|
||||
**URL:** `/ogboot/images/remove/{iso}`
|
||||
Elimina un archivo de arranque específico utilizando su identificador único.
|
||||
|
||||
**URL:** `/ogboot/clients/pxes`
|
||||
**Método HTTP:** DELETE
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{mac}`: La dirección MAC del cliente cuyo archivo de arranque se desea obtener.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/clients/pxes/00:11:22:33:44:55
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El archivo de arranque se eliminó correctamente.
|
||||
- **Código 404 Not Found:** No se encontró ningún archivo de arranque con el identificador único especificado.
|
||||
|
||||
|
||||
|
||||
### Actualizar Repositorio de Arranque
|
||||
|
||||
Actualiza el repositorio de archivos de arranque con los archivos modificados.
|
||||
|
||||
**URL:** `/ogboot/pxes`
|
||||
**Método HTTP:** PUT
|
||||
|
||||
**Cuerpo de la Solicitud:**
|
||||
- Fichero en json con la configuración de arranque de la máquina
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X PUT -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d @data.json http://example.com/ogboot/pxes
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El repositorio de arranque se actualizó exitosamente con los archivos modificados.
|
||||
- **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud.
|
||||
|
||||
|
||||
|
||||
### Obtener Todas las Plantillas
|
||||
|
||||
Obtiene una lista de todas las plantillas de arranque disponibles.
|
||||
|
||||
**URL:** `/ogboot/pxe-templates`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La lista de todas las plantillas de arranque se obtuvo exitosamente.
|
||||
- **Contenido:** Lista de plantillas de arranque en formato JSON.
|
||||
|
||||
|
||||
|
||||
### Obtener Contenido de la Plantilla
|
||||
|
||||
Obtiene el contenido de una plantilla de arranque específica utilizando su nombre.
|
||||
|
||||
**URL:** `/ogboot/pxe-templates/{nombre}`
|
||||
**Método HTTP:** GET
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{nombre}`: El nombre de la plantilla de arranque cuyo contenido se desea obtener.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates/template1
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El contenido de la plantilla de arranque se obtuvo exitosamente.
|
||||
- **Contenido:** Contenido de la plantilla de arranque en formato adecuado para su uso.
|
||||
|
||||
---
|
||||
|
||||
### Crear Plantilla
|
||||
|
||||
Crea una nueva plantilla de arranque utilizando los datos proporcionados.
|
||||
|
||||
**URL:** `/ogboot/pxe-templates`
|
||||
**Método HTTP:** POST
|
||||
|
||||
**Parámetros de entrada:**
|
||||
- `iso`: Nombre de la imagen de ogLive a desinstalar.
|
||||
**Cuerpo de la Solicitud:**
|
||||
- Datos necesarios para la creación de la plantilla de arranque, como el nombre y el contenido.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/images/remove/ogLive-focal-5.13.0-27-beta-amd64-r20210706.5b4bf5f.iso
|
||||
curl -X POST -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d '{"name": "template1", "content": "template_content"}' http://example.com/ogboot/pxe-templates
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El cliente ogLive se desinstaló y la imagen asociada se eliminó exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud es incorrecta. El cliente ogLive no se ha desinstalado correctamente.
|
||||
- **Código 200 OK:** La plantilla de arranque se creó exitosamente.
|
||||
- **Código 400 Bad Request:** La solicitud no pudo ser procesada debido a un error en los datos proporcionados en el cuerpo de la solicitud.
|
||||
|
||||
|
||||
### Regenerar Plantilla
|
||||
|
||||
Regenera el contenido de una plantilla de arranque específica utilizando su nombre.
|
||||
|
||||
**URL:** `/ogboot/pxe-templates/{nombre}`
|
||||
**Método HTTP:** PUT
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{nombre}`: El nombre de la plantilla de arranque que se desea regenerar.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates/template1
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** El contenido de la plantilla de arranque se regeneró exitosamente.
|
||||
- **Código 404 Not Found:** No se encontró ninguna plantilla de arranque con el nombre especificado.
|
||||
|
||||
---
|
||||
|
||||
### Eliminar Plantilla
|
||||
|
||||
Elimina una plantilla de arranque específica utilizando su nombre.
|
||||
|
||||
**URL:** `/ogboot/pxe-templates/{nombre}`
|
||||
**Método HTTP:** DELETE
|
||||
|
||||
**Parámetros de la URL:**
|
||||
- `{nombre}`: El nombre de la plantilla de arranque que se desea eliminar.
|
||||
|
||||
**Ejemplo de Solicitud:**
|
||||
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates/template1
|
||||
```
|
||||
|
||||
**Respuestas:**
|
||||
- **Código 200 OK:** La plantilla de arranque se eliminó correctamente.
|
||||
- **Código 404 Not Found:** No se encontró ninguna plantilla de arranque con el nombre especificado.
|
||||
|
||||
|
|
Loading…
Reference in New Issue