Interface de commande en ligne

Pour les tâches administratives, on dispose de Veyon Configurator et de l’outil de ligne de commande Veyon CLI. Le programme peut être lancé via la commande veyon-cli dans la ligne de commande. Sur Windows, il existe une version supplémentaire non console veyon-wcli qui permet d’automatiser les tâches sans irriter les fenêtres contextuelles de la ligne de commande. Si la variable d’environnement $PATH (Linux) ou :envvar:`%PATH% `(Windows) ne contient pas le répertoire d’installation de Veyon, vous devez d’abord passer au répertoire d’installation ou ajouter le répertoire au nom du programme .

Si le programme est appelé avec le paramètre help, une liste de tous les modules disponibles est affichée. La liste peut varier en fonction des plugins Veyon installés:

$ veyon-cli help
Available modules:
    authkeys - Commands for managing authentication keys
    config - Commands for managing the configuration of Veyon
    ldap - Commands for configuring and testing LDAP/AD integration
    networkobjects - Commands for managing the builtin network object directory
    power - Commands for controlling power status of computers
    remoteaccess - Remote view or control a computer
    service - Commands for configuring and controlling Veyon Service
    shell - Commands for shell functionalities

Tous les modules CLI supportent la commande « help », de sorte qu’une liste de toutes les commandes disponibles peut être affichée pour tous les modules. Exemple de sortie pour le module « config » :

$ veyon-cli config help
Available commands:
    clear - Clear system-wide Veyon configuration
    export - Export configuration to given file
    get - Read and output configuration value for given key
    import - Import configuration from given file
    list - List all configuration keys and values
    set - Write given value to given configuration key
    unset - Unset (remove) given configuration key
    upgrade - Upgrade and save configuration of program and plugins

Pour certains modules, la commande « help » peut être fournie avec un nom de commande comme argument additionnel pour obtenir une aide spécifique à une commande particulière :

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Gestion de clé d’authentification

Le module « authkeys » autorise l’administration de clés d’authentification de sorte que les opérations simples telles qu’importer une clé d’authentification ou attribuer un groupe d’utilisateur puissent être automatisées facilement.

Note

The <KEY> parameter always refers to a key name consisting of a name identifier and a type, e.g. teacher/public. A name identifier must consist of letters only. The type has to be either private or public.

create <NAME>

Cette commande crée une paire de clés d’authentification portant le nom <NAME> et enregistre les clés privée et publique dans les répertoires de clés configurés. Le paramètre doit être un nom pour la clé, qui ne peut contenir que des lettres.

delete <KEY>

Cette commande supprime la clé d’authentification <KEY> depuis le répertoire de clé configuré. Veuillez noter qu’une clé ne peut pas être récupérée une fois qu’elle a été supprimée.

export <KEY> [<FILE>]

Cette commande exporte <KEY> vers <FILE> a clé d’authentification. Si <FILE> n’est pas spécifié, un nom sera construit à partir du nom et du type de <KEY>.

extract <KEY>

Cette commande extrait la clé publique à partir de la clé privée <KEY> et l’enregistre en tant que clé publique associée. Lors de la configuration d’un autre ordinateur maître, il suffit donc de ne transférer que la clé privée. La clé publique peut alors être extraite.

import <KEY> [<FILE>]

Cette commande importe la clé d’authentification <KEY> à partir de <FILE>. Si <FILE> n’est pas spécifié un nom sera construit à partir du nom et du type de <KEY>.

list [details]

Cette commande répertorie toutes les clés d’authentification disponibles dans le répertoire de clés configuré. Si l’option `` details`` est spécifiée, une table avec les détails de la clé sera affichée à la place. Certains détails peuvent être manquants si une clé n’est pas accessible, par exemple. en raison du manque d’autorisations de lecture.

setaccessgroup <KEY> <ACCESS GROUP>

Cette commande ajuste les autorisations d’accès aux fichiers <KEY> de sorte que seul le groupe d’utilisateurs <ACCESS GROUP> ait un accès en lecture à celui-ci.

Gestion de la configuration

La configuration locale de Veyon peut être gérée à l’aide du module config. La configuration complète ainsi que les clés de configuration individuelles peuvent être lues ou écrites.

clear

Cette commande réinitialise toute la configuration locale en supprimant toutes les clés de configuration. Utilisez cette commande pour recréer un état défini sans les anciens paramètres avant d’importer une configuration.

export

Cette commande exporte la configuration locale dans un fichier. Le nom du fichier de destination doit être spécifié en tant que paramètre supplémentaire:

veyon-cli config export myconfig.json
import

Cette commande importe un fichier de configuration précédemment exporté dans la configuration locale. Le nom du fichier de configuration à importer doit être spécifié comme argument supplémentaire:

veyon-cli config import myconfig.json
list [defaults | types]

Cette commande affiche une liste de toutes les clés de configuration et de leurs valeurs correspondantes. De cette façon, vous pouvez obtenir les noms des clés de configuration afin de les lire ou de les écrire individuellement via les commandes get ou set. Lorsque vous spécifiez en outre defaults, la valeur par défaut de chaque clé de configuration est imprimée à la place de la valeur configurée réelle. Alternativement, les types de données des clés de configuration peuvent être inspectés en spécifiant types.

get

Cette commande permet de lire une seule clé de configuration. Le nom de la clé doit être fourni en tant que paramètre.

veyon-cli config get Network/VeyonServerPort
set

Cette commande peut être utilisée pour écrire une seule clé de configuration. Le nom de la clé et la valeur souhaitée doivent être passés en tant qu’arguments supplémentaires:

veyon-cli config set Network/VeyonServerPort 12345
veyon-cli config set Service/Autostart true
veyon-cli config set UI/Language de_DE
unset

Avec cette commande, une seule clé de configuration peut être supprimée, c’est-à-dire que Veyon utilise ensuite la valeur interne par défaut. Le nom de la clé doit être passé comme argument supplémentaire:

veyon-cli config unset Directories/Screenshots
upgrade

Avec cette commande, la configuration de Veyon et tous les plugins peuvent être mis à jour et sauvegardés. Cela peut être nécessaire si les paramètres ou les formats de configuration ont changé en raison de mises à jour de programmes ou de plugins.

Contrôle des fonctionnalités

The feature module provides commands for querying available features and controlling them on remote computers.

list

Affiche une liste avec le nom de toutes les fonctionnalités disponibles.

show

Displays a table with detailed information about all available features. This information include a description, the UID, the name of the plugin providing the respective feature and some other implementation-related details.

start <FEATURE> <HOST ADRESS> [<ARGUMENTS>]

Starts the specified feature on the specified host by connecting to the Veyon Server running remotely. The feature can be specified by name or UID. Use the show command to see all available features. Depending on the feature, additional arguments (such as the text message to display) encoded as a single JSON string have to be specified. Please refer to the developer documentation for more information

stop <FEATURE> <HOST ADRESS>

Stops the specified feature on the specified host by connecting to the Veyon Server running remotely. The feature can be specified by name or UID. Use the show command to see all available features.

LDAP

Les commandes disponibles dans le module ldap sont décrites dans la section Interface de commande en ligne au chapitre Intégration LDAP/AD.

Répertoire objets réseau

Comme décrit dans la section Emplacements & ordinateurs, Veyon fournit un répertoire d’objets réseau intégré qui peut être utilisé quand aucun serveur LDAP n’est disponible. Ce répertoire d’objets réseau peut être géré dans le configurateur Veyon ainsi qu’en ligne de commande. Certaines opérations telles que l’importation au format CSV ne sont actuellement disponibles qu’en ligne de commande. Pour la plupart des commandes, une description détaillée avec des exemples est disponible dans l’aide spécifique à la commande. Les commandes suivantes peuvent être utilisées dans le module networkobjects:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]

Cette commande ajoute un objet, où <TYPE> peut être location ou computer. <PARENT> peut être spécifié par un nom ou l’UUID (identifiant universel unique).

clear

Cette commande réinitialise l’ensemble du répertoire des objets réseau, c’est-à-dire que tous les emplacements et ordinateurs sont supprimés. Cette opération est particulièrement utile avant toute importation automatisée.

dump

Cette commande affiche le répertoire complet des objets de réseau sous forme d’un tableau. Chaque propriété, telle que l’UID, le type ou le nom de l’objet, est affichée dans une colonne distincte.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]

Cette commande peut être utilisée pour exporter le répertoire d’objets réseau complet ou uniquement l’emplacement spécifié dans un fichier texte. Le formatage peut être contrôlé via une chaîne de format contenant des variables d’espace réservé. Cela permet de générer facilement un fichier CSV. Les variables valides sont %type%, %name%, %host%, %mac% et %location%. Différents exemples sont donnés dans l’aide aux commandes (veyon-cli networkobjects help export).

Note

Lorsque vous utilisez cette commande dans des fichiers de traitement par lots ou par le biais de tâches planifiées sous Windows, assurez-vous d’échapper correctement au signe de pourcentage, c’est-à-dire, utilisez %%type%% au lieu de %type%. Sinon, les parties individuelles des chaînes de format seront traitées comme des variables d’environnement et seront remplacées par des chaînes vides dans la plupart des cas. Cela conduira à des erreurs d’analyse inattendues.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]

Cette commande peut être utilisée pour importer un fichier texte dans le répertoire des objets de réseau. Le traitement des données d’entrée peut être contrôlé via une chaîne de format ou une expression régulière contenant des variables d’espace réservé. De cette façon, les fichiers CSV et d’autres types de données structurées peuvent être importés. Les variables valides sont %type%, %name%, %host%, %mac% et %location%. Plusieurs exemples sont donnés dans la commande d’aide (veyon-cli networkobjects help import).

Note

Lorsque vous utilisez cette commande dans des fichiers de traitement par lots ou par le biais de tâches planifiées sous Windows, assurez-vous d’échapper correctement au signe de pourcentage, c’est-à-dire, utilisez %%type%% au lieu de %type%. Sinon, les parties individuelles des chaînes de format seront traitées comme des variables d’environnement et seront remplacées par des chaînes vides dans la plupart des cas. Cela conduira à des erreurs d’analyse inattendues.

list

Cette commande imprime le répertoire complet de l’objet réseau sous forme de liste formatée. Contrairement à la commande `` dump``, la hiérarchie des emplacements et des ordinateurs est représentée par un formatage approprié.

remove <OBJECT>

Cette commande supprime l’objet spécifié du répertoire. L’OBJET peut être spécifié par son nom ou par son UUID (identifiant universel unique). Supprimer un emplacement supprimera également tous les ordinateurs associés.

Alimentation

Le module power permet d’utiliser les fonctions liées à l’alimentation depuis la ligne de commande.

on <MAC ADDRESS>

Cette commande diffuse un paquet Wake-on-LAN (WOL) sur le réseau afin d’allumer l’ordinateur correspondant à l’adresse MAC donnée.

Accès à distance

Le module remoteaccess fournit des fonctions pour un accès graphique à distance aux ordinateurs. Ce sont les mêmes fonctions accessibles depuis le Veyon Maître. La fonction fournie par l’outil de ligne de commande peut être utilisée, par exemple, pour créer un raccourci de programme permettant un accès direct à un ordinateur spécifique.

control

Cette commande ouvre une fenêtre avec la fonction de contrôle à distance pouvant être utilisée pour contrôler un ordinateur distant. Le nom d’ordinateur ou l’adresse IP (et éventuellement le port TCP) doit être passé en argument:

veyon-cli remoteaccess control 192.168.1.2
view

Cette commande ouvre une fenêtre avec la fonction de visualisation à distance pour surveiller un ordinateur distant. Dans ce mode, le contenu de l’écran est affiché en temps réel, mais l’interaction avec l’ordinateur n’est pas possible tant que l’utilisateur n’a pas cliqué sur le bouton correspondant de la barre d’outils. L’ordinateur ou l’adresse IP (et éventuellement le port TCP) doit être passé en argument:

veyon-cli remoteaccess view pc5:5900

Contrôle du service

Le module `` service`` peut être utilisé pour contrôler le service Veyon local.

register

Cette commande enregistre le service Veyon en tant que service dans le système d’exploitation afin qu’il soit automatiquement lancé au démarrage de l’ordinateur.

unregister

Cette commande supprime l’enregistrement du service dans le système d’exploitation de sorte que le service Veyon ne soit plus démarré automatiquement au démarrage.

start

Cette commande démarre le Service Veyon.

stop

Cette commande arrête le Service Veyon.

restart

Cette commande redémarre le Service Veyon.

status

Cette commande interroge et affiche l’état du Service Veyon.

interpréteur de commandes

Les fonctionnalités simples du shell sont fournies par le module shell. Si ce module est appelé sans arguments supplémentaires, un mode interactif est lancé. Dans ce mode, toutes les commandes CLI peuvent être entrées directement sans qu’il soit nécessaire de spécifier et d’appeler le programme veyon-cli pour chaque commande. Le mode peut être quitté en entrant le mot-clé exit.

De plus, le module peut être utilisé pour le traitement automatisé de commandes dans un fichier texte afin de mettre en œuvre un traitement par lots simple:

run <FILE>

Cette commande exécute les commandes spécifiées dans le fichier texte ligne par ligne. Les opérations sont exécutées indépendamment du résultat des opérations précédentes, c’est-à-dire qu’une erreur ne conduit pas à la fermeture du programme.