Passer au contenu principal

Référence CLI Level

Reference for lvl command groups, output formats, pagination, resource references, and safety behavior.

Utilisez cet article comme carte de l'arborescence des 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étences générée :

lvl --help
lvl skill describe

Par exemple :

lvl device list --help
lvl skill describe device list

Syntaxe des commandes

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

Level CLI inclut un prod profil pour https://api.level.io.

La sélection du profil suit cet ordre :

  1. La --profile indicateur.

  2. La LVL_PROFILE variable d'environnement.

  3. Le profil par défaut enregistré.

  4. Le prod profil.

Commandes courantes :

Commande

Objectif

lvl auth login

Se connecter via un flux d'approbation basé sur le navigateur.

lvl auth status

Vérifier la session active et l'organisation.

lvl auth logout

Révoquer la session active et supprimer les identifiants locaux.

lvl profile list

Lister les profils de serveur API configurés.

lvl profile create <name> <url>

Ajouter un profil. Utiliser --default pour le sélectionner immédiatement.

lvl profile use <profile>

Définir le profil par défaut.

lvl profile delete <profile>

Supprimer la configuration et les identifiants 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.

Mises à jour de la CLI

Les versions de publication se maintiennent à jour par défaut. Lorsque vous exécutez une lvl la CLI applique toute mise à jour signée précédemment découverte et réexécute la commande avec le nouveau binaire. Si aucune mise à jour n'est en attente, elle en vérifie une en arrière-plan et peut l'appliquer lors de la prochaine invocation. Les échecs de mise à jour automatique n'arrêtent pas la commande que vous avez demandé lvl à exécuter.

Commande

Objectif

lvl self-update

Vérifier et installer immédiatement la dernière version publiée. Cela fonctionne même lorsque les mises à jour automatiques sont désactivées.

lvl self-update --check

Indiquer si une mise à jour est disponible sans l'installer.

lvl self-update url

Afficher l'URL de version actuellement utilisée pour les mises à jour.

lvl self-update url <url>

Enregistrer une URL de version personnalisée dans ~/.lvl/config.yaml.

lvl self-update url --reset

Supprimer l'URL personnalisée et revenir à la source de production intégrée.

Définir auto_update: false dans ~/.lvl/config.yaml pour désactiver les vérifications automatiques et les mises à jour au démarrage. Vous pouvez toujours exécuter lvl self-update manuellement.

Formats de sortie

La plupart des commandes affichent par défaut un tableau ou un résumé lisible par l'utilisateur.

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 JSON. Il ne peut pas être combiné avec une sortie de tableau explicite.

Les commandes d'exportation 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 -o indicateur pour la spécification elle-même.

Pagination

La plupart des commandes de liste de ressources prennent en charge :

Indicateur

Comportement

--limit <count>

Retourner jusqu'au nombre de résultats demandé. La valeur par défaut est 100.

--limit all

Récupérer toutes les pages de résultats.

--page <number>

Retourner une page à base 1.

--limit all ne peut pas être combiné avec --page.

Les commandes paginées incluent les listes d'alertes, d'automatisations, de déclencheurs d'automatisation, d'appareils, de fichiers, de moniteurs, 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, groupes, champs personnalisés, profils et variables utilisent des listes non paginées.

Dans la sortie de liste JSON, count est le nombre total de résultats correspondants sur le serveur, 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 l'utilisateur. 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 <group>/<hostname>

Groupe d'appareils

Identifiant, nom, ou chemin imbriqué tel que Ops/Maintenance

Automatisation

Identifiant ou nom

Script

Identifiant ou nom

Fichier du dépôt

Identifiant ou nom de fichier, avec ou sans son 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 KB préfixe

Si une référence correspond à plusieurs ressources, la CLI s'arrête et liste les candidats plutôt que d'en choisir un.

Commandes d'alertes

Commande

Objectif

alert list

Lister les alertes actives, résolues, ou toutes les alertes.

alert get <alert-id>

Obtenir une alerte.

alert resolve

Résoudre des alertes par identifiant ou filtres.

alert unresolve <alert-id>...

Rouvrir des alertes résolues par identifiant.

alert export

Exporter les alertes correspondantes en CSV.

Commandes de clés API

Commande

Objectif

apikey list

Lister les clés API.

apikey get <api-key>

Obtenir une clé API. Utiliser --reveal pour afficher le jeton complet dans la sortie du tableau.

apikey create

Créer une clé API en lecture seule ou en lecture-écriture.

apikey update <api-key>

Mettre à jour une clé API.

apikey delete <api-key>...

Supprimer définitivement des clés API.

⚠️ AVERTISSEMENT : La sortie JSON des clés API contient le jeton complet. Protégez la sortie du terminal, les fichiers exportés et les journaux CI.

Commandes d'automatisation

Commande

Objectif

automation list

Lister les automatisations.

automation get <automation>

Obtenir une automatisation.

automation create

Créer une automatisation à partir d'indicateurs ou d'un fichier de spécification.

automation spec <automation>

Exporter une spécification d'automatisation.

automation apply -f <spec>

Réconcilier une automatisation existante avec une spécification.

automation update <automation>

Mettre à jour les propriétés d'automatisation.

automation delete <automation>...

Archiver des automatisations.

automation restore <automation>...

Restaurer des automatisations archivées.

automation run <automation>

Exécuter une automatisation sur des appareils ou des groupes.

automation trigger ...

Lister, ajouter, mettre à jour, supprimer ou exécuter manuellement des déclencheurs.

automation action ...

Ajouter, mettre à jour ou supprimer des actions.

automation variable ...

Gérer les variables d'automatisation.

automation group ...

Gérer les groupes d'automatisation.

Valeurs de statut :

  • automation list signale active lorsqu'une automatisation a au moins un déclencheur activé, manual lorsqu'elle n'a aucun déclencheur activé, et archived lorsqu'elle est archivée.

  • automation trigger list signale active pour un déclencheur activé et disabled pour un déclencheur non activé.

  • L'exécution de l'automatisation est contrôlée par l'état du déclencheur. L'ancienne enabled la valeur ne détermine pas ces statuts ni si les déclencheurs peuvent lancer des exécutions.

Les commandes de mutation de déclencheurs et d'actions acceptent --json ou --json-file. La charge utile 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 des déclencheurs et des actions absents de la spécification. L'application n'est pas transactionnelle. Exécuter avec --dry-run et examiner le plan en premier.

Commandes d'applications

Utilisez ces commandes pour examiner l'inventaire des applications à l'échelle de l'organisation et explorer les versions ou les installations individuelles.

Commande

Objectif

app list

Lister une ligne agrégée par nom d'application, éditeur et plateforme. Prend en charge la pagination.

app summary

Afficher les comptages d'applications et d'installations, y compris le nombre d'applications par plateforme, pour le périmètre filtré.

app versions <app>

Lister les versions d'une application avec les comptages d'installations et d'appareils.

app installs [<app>]

Lister les installations individuelles d'une application, ou omettre <app> et passer exactement un --device pour lister l'inventaire complet des applications de cet appareil. Prend en charge la pagination.

app uninstall [<app>...]

Envoyer des commandes de désinstallation pour les installations d'applications sélectionnées. Les références d'applications positionnelles sont équivalentes aux indicateurs répétables --app indicateurs.

Téléversements de fichiers

Téléverser un ou plusieurs fichiers locaux vers le dépôt de fichiers Level :

lvl file upload <path>...

Par défaut, lvl utilise le nom de fichier local. Pour choisir un nom personnalisé pour un fichier, utiliser --name sans extension :

lvl file upload <path> --name <name>

L'extension du fichier provient toujours du fichier local. Le --name l'option s'applique à un seul fichier uniquement.

Avez-vous trouvé la réponse à votre question ?