Script d’assistance API

Guide d’utilisation du script d’assistance yb-api de VergeOS pour simplifier les interactions avec l’API, y compris l’affichage, la création, le clonage et la gestion des machines virtuelles depuis la ligne de commande.

Le yb-api Le script d'aide fournit aux développeurs un moyen simple d'interagir avec l'API VergeOS. Il simplifie l'exécution d'appels API, comme la récupération des machines virtuelles, la mise à jour des configurations et la gestion des ressources. Ce guide présentera les commandes clés et l'utilisation du yb-api script.

Prérequis

• Accès à un système VergeOS.
• Accès au cluster via SSH ou connexion directe.
• wget et curl doit être installé sur le système pour certaines opérations.

Exécution du script d'aide

Pour obtenir de l'aide ou voir les options disponibles, exécutez :

yb-api --help

Connectez-vous au nœud et exécutez cette commande pour commencer à utiliser l'assistant d'API.

Exemple yb-api

Exemples de commandes

Vous trouverez ci-dessous des exemples d'utilisation de yb-api pour diverses tâches de gestion de VM.

Obtenir une liste des machines virtuelles (sans les instantanés)

Récupérer une liste des VM et filtrer les instantanés.

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

Export simple de toutes les VM

Cette commande récupère une liste de toutes les VM. Les --server, --user, --filteret --fields sont facultatives dans ce cas.

yb-api --get /v4/vms

Obtenir des informations détaillées sur la VM

Récupérer la plupart des champs, y compris les informations sur les disques et les NIC, pour une VM spécifique (VM 1 dans ce cas).

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

Renommer une machine virtuelle

Modifier le nom d'une machine virtuelle existante (VM 1) en "NEWNAME".

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

Supprimer une machine virtuelle

Supprimer une VM spécifique (VM 1), en utilisant son $key.

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

Créer une nouvelle machine virtuelle

Créer une nouvelle VM avec des configurations spécifiques (nom, cœurs 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

Obtenir le schéma de la table de la base de données des VM

Récupérer le schéma de la table de base de données des VM.

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

Cloner une machine virtuelle

Cloner une VM existante (VM 1) et lui donner un nouveau nom.

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

Mettre sous tension une machine virtuelle

Mettre sous tension une VM existante (VM 1).

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

Remarques sur yb-api

• Le yb-api le script s'appuie sur wget, qui peut ne pas être installé par défaut sur macOS. Assurez-vous de l'installer si nécessaire.
• curl est utilisé pour la fonction de téléversement dans certains appels API, comme l'envoi de données pour créer de nouvelles VM.

---

En utilisant le yb-api script d'aide, les développeurs peuvent simplifier l'interaction avec l'API VergeOS et gérer les machines virtuelles plus efficacement. Faites-nous savoir si vous avez besoin d'aide pour d'autres commandes ou options.

---

Informations sur le document

• Dernière mise à jour : 2024-08-29
• Version de vergeOS : 4.12.6