Utilisez cet article comme carte de l'arborescence de commandes CLI Level. Pour les indicateurs exacts et la forme de sortie JSON dans votre version installée, utilisez l'aide normale ou la référence de compétence générée :
lvl --help
lvl skill describe
Par exemple :
lvl device list --help
lvl skill describe device list
Syntaxe de commande
La forme générale est :
lvl [--profile ] [arguments] [flags]
Afficher la liste des commandes de niveau supérieur :
lvl --help
Afficher toutes les entrées de référence générées :
lvl skill describe
Profils et authentification
Le CLI Level inclut un prod profil pour https://api.level.io.
La sélection du profil suit cet ordre :
La racine
--profileindicateur.La
LVL_PROFILEvariable d'environnement.Le profil par défaut enregistré.
Le
prodprofil.
Commandes courantes :
Commande | Objectif |
| Se connecter via un flux d'approbation basé sur un navigateur. |
| Vérifier la session active et l'organisation. |
| Révoquer la session active et supprimer les informations d'identification locales. |
| Lister les profils de serveur API configurés. |
| Ajouter un profil. Utiliser |
| Définir le profil par défaut. |
| Supprimer la configuration et les informations d'identification du profil local. |
⚠️ AVERTISSEMENT : La suppression d'un profil ne révoque pas sa session côté serveur. Exécuter lvl --profile <profile> auth logout avant de le supprimer.
Formats de sortie
La plupart des commandes affichent par défaut un tableau ou un résumé lisible par un humain.
Utiliser la sortie JSON :
lvl device list -o json
Utiliser le filtre jq intégré :
lvl device list --jq '.list[] | {id, name, online}'--jq implique le JSON. Il ne peut pas être combiné avec une sortie tableau explicite.
Les commandes d'export CSV écrivent du CSV brut vers la sortie standard :
lvl device export > devices.csv
lvl alert export > alerts.csv
lvl run export > runs.csv
Les commandes de spécification d'automatisation et de politique de surveillance utilisent --format yaml|json, avec YAML comme valeur par défaut. Elles n'utilisent pas l'indicateur standard -o indicateur pour la spécification elle-même.
Pagination
La plupart des commandes de liste de ressources prennent en charge :
Indicateur | Comportement |
| Retourner jusqu'au nombre d'enregistrements demandé. La valeur par défaut est 100. |
| Récupérer toutes les pages de résultats. |
| Retourner une page basée sur 1. |
--limit all ne peut pas être combiné avec --page.
Les commandes paginées comprennent les listes d'alertes, d'automatisations, de déclencheurs d'automatisation, d'appareils, de fichiers, de surveillances, de politiques de surveillance, d'exécutions, de scripts, de balises, de mises à jour, de résumés de mises à jour, d'appareils mis à jour, de journaux de mises à jour et d'exclusions de mises à jour.
Les clés API, les groupes, les champs personnalisés, les profils et les variables utilisent des listes non paginées.
Dans la sortie de liste JSON, count est le nombre total d'enregistrements serveur correspondants, et non le nombre retourné sur la page actuelle.
Références de ressources
De nombreuses commandes acceptent un identifiant ou une référence lisible par un humain. Une correspondance exacte d'identifiant est prioritaire. La correspondance par nom et alias est insensible à la casse.
Les formes courantes incluent :
Ressource | Références acceptées |
Appareil | Identifiant, nom d'hôte, nom, surnom, ou |
Groupe d'appareils | Identifiant, nom, ou chemin imbriqué tel que |
Automatisation | Identifiant ou nom |
Script | Identifiant ou nom |
Fichier du dépôt | Identifiant ou nom de fichier, avec ou sans extension |
Politique de surveillance | Identifiant ou nom |
Balise | Nom |
Champ personnalisé | Nom ou référence générée |
Exclusion de mise à jour | Identifiant ou numéro KB, avec ou sans le |
Si une référence correspond à plus d'une ressource, le CLI s'arrête et liste les candidats au lieu d'en choisir un.
Commandes d'alerte
Commande | Objectif |
| Lister les alertes actives, résolues ou toutes les alertes. |
| Obtenir une alerte. |
| Résoudre les alertes par identifiant ou filtres. |
| Rouvrir les alertes résolues par identifiant. |
| Exporter les alertes correspondantes au format CSV. |
Commandes de clé API
Commande | Objectif |
| Lister les clés API. |
| Obtenir une clé API. Utiliser |
| Créer une clé API en lecture seule ou en lecture-écriture. |
| Mettre à jour une clé API. |
| Supprimer définitivement les clés API. |
⚠️ AVERTISSEMENT : La sortie JSON de la clé API contient le jeton complet. Protégez la sortie du terminal, les fichiers exportés et les journaux CI.
Commandes d'automatisation
Commande | Objectif |
| Lister les automatisations. |
| Obtenir une automatisation. |
| Créer une automatisation à partir d'indicateurs ou d'un fichier de spécification. |
| Exporter une spécification d'automatisation. |
| Réconcilier une automatisation existante avec une spécification. |
| Mettre à jour les propriétés d'automatisation. |
| Archiver les automatisations. |
| Restaurer les automatisations archivées. |
| Exécuter une automatisation sur des appareils ou des groupes. |
| Lister, ajouter, mettre à jour, supprimer ou exécuter manuellement des déclencheurs. |
| Ajouter, mettre à jour ou supprimer des actions. |
| Gérer les variables d'automatisation. |
| Gérer les groupes d'automatisation. |
Les commandes de mutation de déclencheur et d'action acceptent --json ou --json-file. Le contenu doit contenir exactement un type pris en charge, et les champs inconnus sont rejetés.
Exécuter lvl automation action --help ou lvl skill describe automation action pour les types d'actions pris en charge par votre version installée.
⚠️ AVERTISSEMENT :automation apply peut supprimer les déclencheurs et les actions absents de la spécification. L'application n'est pas transactionnelle. Exécuter avec --dry-run et examiner le plan en premier.
Commandes de champs personnalisés
Commande | Objectif |
| Lister les champs personnalisés de l'organisation. |
| Obtenir un champ personnalisé. |
| Créer un champ. |
| Mettre à jour un champ. |
| Supprimer des champs. |
| Définir une valeur au niveau de l'organisation. |
| Effacer une valeur au niveau de l'organisation. |
| Lister, définir ou effacer les valeurs au niveau de l'appareil. |
| Lister, définir ou effacer les valeurs des groupes d'appareils. |
Les valeurs des champs personnalisés sont héritées de l'organisation vers le groupe d'appareils puis vers l'appareil. Les opérations de définition ou d'effacement en cascade peuvent écraser ou supprimer les valeurs descendantes.
Commandes d'appareils
Commande | Objectif |
| Lister et filtrer les appareils. |
| Obtenir les détails de l'appareil. |
| Demander un redémarrage. |
| Demander un arrêt. |
| Modifier le mode maintenance. |
| Mettre à jour les propriétés modifiables de l'appareil. |
| Supprimer définitivement les appareils. |
| Modifier le statut de favori. |
| Modifier le statut de signalement. |
| Exporter les appareils au format CSV. |
| Imprimer une clé d'installation d'agent pour le provisionnement. |
| Gérer les groupes d'appareils et les affectations. |
| Gérer les valeurs des champs personnalisés des appareils. |
Le redémarrage et l'arrêt demandent l'action immédiatement et n'attendent pas que l'appareil la complète.
⚠️ AVERTISSEMENT :device install-key imprime une information d'identification de provisionnement vers la sortie standard. Évitez de l'exposer dans l'historique du shell, les terminaux partagés ou les journaux CI.
Commandes de fichiers
Commande | Objectif |
| Lister les fichiers du dépôt. |
| Obtenir les métadonnées du fichier. |
| Téléverser des fichiers locaux. |
| Télécharger un fichier. Utiliser |
| Renommer un fichier du dépôt. |
| Remplacer le contenu d'un fichier tout en conservant l'identifiant du fichier du dépôt. |
| Supprimer définitivement les fichiers. |
| Afficher l'utilisation du stockage. |
| Gérer les groupes de fichiers du dépôt. |
file download --overwrite peut remplacer un fichier local existant. Remplacer un fichier du dépôt modifie le contenu utilisé par les automatisations qui font référence à cet identifiant de fichier.
Commandes de surveillance
Commande | Objectif |
| Lister les surveillances dans les politiques. |
| Obtenir une surveillance. |
| Ajouter une surveillance à une politique à partir d'un contenu JSON. |
| Mettre à jour une surveillance avec un contenu JSON. |
| Supprimer des surveillances. |
| Remplacer les surveillances pour un appareil. |
| Lister les politiques de surveillance. |
| Obtenir une politique. |
| Créer une politique à partir d'indicateurs ou d'une spécification. |
| Exporter une spécification de politique. |
| Réconcilier une politique avec une spécification. |
| Gérer les balises cibles. |
Les commandes de contenu de surveillance acceptent --json ou --json-file. Exécuter lvl monitor add --help pour les types de surveillance pris en charge.
L'application de la politique de surveillance peut supprimer les surveillances absentes du fichier et n'est pas transactionnelle. Utiliser --dry-run en premier.
Commandes d'exécution
Commande | Objectif |
| Lister les exécutions d'automatisation et de script. |
| Obtenir une exécution et ses étapes. Utiliser |
| Annuler des exécutions par identifiant ou filtres. |
| Démarrer de nouvelles exécutions à partir d'exécutions sélectionnées. |
| Relancer les exécutions échouées depuis l'étape défaillante. |
| Approuver les exécutions en attente à une étape d'approbation. |
| Refuser et annuler les exécutions en attente à une étape d'approbation. |
| Exporter les exécutions au format CSV. |
L'attente est par défaut de 15 minutes et retourne jusqu'à 1 000 lignes de sortie par étape. Utiliser --wait-timeout et --output-lines pour modifier ces limites.
Un ERROR ou CANCELED le résultat se termine avec un code non nul. Un WARNING le résultat est traité comme réussi.
Commandes de script
Commande | Objectif |
| Lister les scripts enregistrés. |
| Obtenir un script enregistré. Utiliser |
| Créer un script à partir de |
| Mettre à jour un script enregistré. |
| Supprimer des scripts. |
| Exécuter un script enregistré, un fichier ou une commande en ligne. |
| Gérer les variables de script. |
| Gérer les groupes de scripts. |
Une cible d'exécution peut provenir d'indicateurs répétés --device indicateurs, --group, ou les deux. Les cibles en double ne sont exécutées qu'une seule fois.
Un script enregistré utilise son shell stocké, son délai d'expiration et son paramètre d'exécution. Les exécutions de script ad hoc déduisent le shell à partir d'un indicateur explicite, d'une extension de fichier, d'un shebang ou du système d'exploitation cible.
⚠️ AVERTISSEMENT : La création de script et les exécutions de script ad hoc utilisent par défaut le paramètre SYSTEM paramètre d'exécution. Examinez le script et la liste des cibles avant l'exécution.
Commandes de compétence
Commande | Objectif |
| Imprimer la |
| Installer la compétence pour l'utilisateur actuel. |
| Installer la compétence dans le projet actuel. |
| Imprimer les indicateurs et les définitions de sortie JSON. |
Réinstaller la compétence après la mise à niveau de lvl afin que les agents de codage reçoivent l'arborescence de commandes actuelle.
Commandes de balises
Commande | Objectif |
| Lister les balises. |
| Obtenir une balise. |
| Créer une balise. |
| Mettre à jour une balise. |
| Supprimer les balises inutilisées. |
| Affecter une balise aux appareils. |
| Retirer une balise des appareils. |
Commandes de mise à jour
Commande | Objectif |
| Lister les mises à jour disponibles, installées ou toutes les mises à jour. |
| Obtenir une mise à jour. |
| Demander une analyse des mises à jour. |
| Installer les mises à jour sélectionnées. |
| Relancer les installations échouées sélectionnées. |
| Installer les mises à jour disponibles sur les appareils sélectionnés. |
| Examiner les enregistrements d'installation de mise à jour et les journaux. |
| Lister les résumés de mises à jour. |
| Lister les appareils dans le contexte de mise à jour. |
| Gérer les exclusions KB globales. |
L'installation de mise à jour, la relance et l'installation de toutes les mises à jour autorisent les redémarrages requis par défaut. Utiliser --no-reboot lorsque la commande sélectionnée ne doit pas redémarrer un appareil.
⚠️ AVERTISSEMENT : Examinez les sélections de mise à jour et d'appareil avant l'installation. Les opérations basées sur des filtres et sur tous les appareils nécessitent une confirmation explicite.
Commandes de groupe
Les groupes d'appareils, de scripts, d'automatisations et de fichiers partagent ces sous-commandes :
listcreaterenamemovedeleteassignunassign
Les listes de groupes récupèrent la hiérarchie complète. La suppression d'un groupe requiert qu'il soit vide et n'ait aucun groupe enfant.
Confirmation et travail asynchrone
Les commandes de suppression permanente prennent en charge --yes. Dans un terminal interactif, le CLI peut inviter l'utilisateur. Dans une exécution non interactive, les commandes qui nécessitent une confirmation échouent sauf si --yes est fourni.
Certaines commandes retournent après que Level a accepté la demande, avant que le travail ne soit terminé sur un appareil. Celles-ci comprennent les actions d'alimentation, les vérifications et installations de mises à jour, les scripts, les automatisations et les exécutions de déclencheurs. Utilisez l'historique des exécutions, run get --wait, les journaux de mise à jour, ou l'application web Level pour confirmer le résultat final.
