Script auxiliar de la API

Una guía para usar el script auxiliar yb-api de VergeOS para interacciones simplificadas con la API, incluyendo listar, crear, clonar y administrar máquinas virtuales desde la línea de comandos.

El yb-api el script auxiliar proporciona una forma sencilla para que los desarrolladores interactúen con la API de VergeOS. Simplifica la realización de llamadas a la API, como recuperar máquinas virtuales, actualizar configuraciones y gestionar recursos. Esta guía describirá los comandos clave y el uso del yb-api script.

Requisitos previos

• Acceso a un sistema VergeOS.
• Acceso al clúster mediante SSH o conexión directa.
• wget y curl debe estar instalado en el sistema para ciertas operaciones.

Ejecución del script auxiliar

Para obtener ayuda o ver las opciones disponibles, ejecute:

yb-api --help

Conéctese al nodo y ejecute este comando para comenzar a usar el asistente de la API.

Ejemplo de yb-api

Comandos de ejemplo

A continuación se muestran ejemplos de cómo usar yb-api para diversas tareas de administración de VM.

Obtener una lista de máquinas virtuales (excluyendo instantáneas)

Recuperar una lista de VM y filtrar las instantáneas.

yb-api --get --user=admin --server=10.0.0.100 \
--fields='name,$key,ram,machine#status#status as machine_status' \
--filter='is_snapshot eq false' /v4/vms

Volcado simple de todas las VM

Este comando recupera una lista de todas las VM. Los --server, --user, --filter, y --fields indicadores son opcionales en este caso.

yb-api --get /v4/vms

Obtener información detallada de la VM

Recupere la mayoría de los campos, incluida la información de discos y NIC, para una VM específica (VM 1 en este caso).

yb-api --get --user=admin --server=10.0.0.100 \
--fields='most,machine[most,drives[most],nics[most]]' /v4/vms/1

Cambiar el nombre de una máquina virtual

Cambie el nombre de una máquina virtual existente (VM 1) a "NEWNAME".

yb-api --put='{"name":"NEWNAME"}' --user=admin --server=10.0.0.100 /v4/vms/1

Eliminar una máquina virtual

Eliminar una VM específica (VM 1), usando su $key.

yb-api --delete --user=admin --server=10.0.0.100 \
--fields='name,$key,ram' /v4/vms/1

Crear una nueva máquina virtual

Crear una nueva VM con configuraciones específicas (nombre, núcleos de CPU, RAM, etc.).

yb-api --post='{"name":"NEWVM","enabled":true,"description":"test vm",\
"os_family":"linux","cpu_cores":4,"ram":"8192"}' --user=admin \
--server=10.0.0.100 /v4/vms

Obtener el esquema de la tabla de la base de datos de VM

Recupere el esquema de la tabla de la base de datos de VM.

yb-api --get --user=admin --server=10.0.0.100 '/v4/vms/$table'

Clonar una máquina virtual

Clonar una VM existente (VM 1) y darle un nuevo nombre.

yb-api --get --user=admin --server=10.0.0.100 '/v4/vm_actions' \
--post='{"vm":1, "action": "clone", "params": {"name": "NEW VM NAME"}}'

Encender una máquina virtual

Encender una VM existente (VM 1).

yb-api --get --user=admin --server=10.0.0.100 '/v4/vm_actions' \
--post='{"vm":1, "action": "poweron"}'

Notas sobre yb-api

• El yb-api el script depende de wget, que puede no estar instalado de forma predeterminada en macOS. Asegúrese de instalarlo si es necesario.
• curl se utiliza para la función de carga en ciertas llamadas a la API, como enviar datos para crear nuevas VM.

---

Al usar el yb-api script auxiliar, los desarrolladores pueden simplificar la interacción con la API de VergeOS y gestionar las máquinas virtuales de manera más eficiente. Háganos saber si necesita ayuda con más comandos u opciones.

---

Información del documento

• Última actualización: 2024-08-29
• Versión de vergeOS: 4.12.6