Kommandoradsgränssnitt

För administrativa uppgifter finns Veyon Configurator och kommandoradsverktyget Veyon CLI tillgängliga. Programmet kan startas via kommandot veyon-cli i kommandoraden. På Windows finns det ytterligare en icke-konsolversion veyon-wcli som gör det möjligt att automatisera uppgifter utan irriterande popup-fönster på kommandoraden. Om miljövariabeln $PATH (Linux) eller %PATH% (Windows) inte innehåller Veyons installationskatalog måste du först byta till installationskatalogen eller lägga till katalogen före programnamnet.

Om programmet anropas med parametern help visas en lista över alla tillgängliga moduler. Listan kan variera beroende på vilka Veyon-plugins som är installerade:

$ 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

Varje CLI-modul har stöd för kommandot help, så att en lista över alla tillgängliga kommandon kan visas för varje modul. Exempel på utdata för modulen 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

För vissa moduler kan kommandot help anges med ett kommandonamn som ett extra argument för att få specifik hjälp för ett kommando:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Hantering av autentiseringsnycklar

Modulen authkeys möjliggör hantering av autentiseringsnycklar så att vanliga åtgärder som att importera en autentiseringsnyckel eller tilldela en användargrupp enkelt kan automatiseras.

Observera

Parametern <KEY> hänvisar alltid till ett nyckelnamn som består av en namnidentifierare och en typ, t.ex. teacher/public. En namnidentifierare får endast bestå av bokstäver. Typen måste vara antingen private eller public.

create <NAME>: Detta kommando skapar ett nyckelpar för autentisering med namnet <NAME> och sparar den privata och offentliga nyckeln i de konfigurerade nyckelkatalogerna. Parametern måste vara ett namn för nyckeln, som endast får innehålla bokstäver.

delete <KEY>: Detta kommando raderar autentiseringsnyckeln <KEY> från den konfigurerade nyckelkatalogen. Observera att en nyckel inte kan återställas när den har tagits bort.

export <KEY> [<FILE>]: Detta kommando exporterar autentiseringsnyckeln <KEY> till <FILE>. Om <FILE> inte anges kommer ett namn att konstrueras utifrån namn och typ för <KEY>.

extract <KEY>: Detta kommando extraherar den offentliga nyckeldelen från den privata nyckeln <KEY> och sparar den som tillhörande offentlig nyckel. När du installerar en annan huvuddator räcker det därför med att endast överföra den privata nyckeln. Den publika nyckeln kan sedan extraheras.

import <KEY> [<FILE>]: Detta kommando importerar autentiseringsnyckeln <KEY> från <FILE>. Om <FILE> inte anges kommer ett namn att konstrueras utifrån namn och typ i <KEY>.

list [details]: Detta kommando listar alla tillgängliga autentiseringsnycklar i den konfigurerade nyckelkatalogen. Om alternativet details anges visas i stället en tabell med nyckelinformation. Vissa detaljer kan saknas om en nyckel inte är tillgänglig, t.ex. på grund av avsaknad av läsbehörighet.

setaccessgroup <KEY> <ACCESS GROUP>: Detta kommando justerar filåtkomstbehörigheterna för <KEY> så att endast användargruppen <ACCESS GROUP> har läsåtkomst till den.

Konfigurationshantering

Den lokala Veyon-konfigurationen kan hanteras med hjälp av modulen config. Både den fullständiga konfigurationen och enskilda konfigurationsnycklar kan läsas eller skrivas.

clear: Detta kommando återställer hela den lokala konfigurationen genom att radera alla konfigurationsnycklar. Använd det här kommandot för att återskapa ett definierat tillstånd utan gamla inställningar innan du importerar en konfiguration.

export

Detta kommando exporterar den lokala konfigurationen till en fil. Namnet på målfilen måste anges som en extra parameter:

veyon-cli config export myconfig.json

import

Med detta kommando importeras en tidigare exporterad konfigurationsfil till den lokala konfigurationen. Namnet på den konfigurationsfil som ska importeras måste anges som ett extra argument:

veyon-cli config import myconfig.json

list [defaults | types]: Detta kommando visar en lista över alla konfigurationsnycklar och deras motsvarande värden. På så sätt kan du få namnen på konfigurationsnycklarna för att kunna läsa eller skriva dem individuellt via kommandona get eller set. Om du dessutom anger defaults skrivs standardvärdet för varje konfigurationsnyckel ut i stället för det faktiska konfigurerade värdet. Alternativt kan datatyperna för konfigurationsnycklarna inspekteras genom att ange types.

get

Med detta kommando kan du läsa en enda konfigurationsnyckel. Namnet på nyckeln måste anges som en parameter.

veyon-cli config get Network/VeyonServerPort

set

Detta kommando kan användas för att skriva en enda konfigurationsnyckel. Namnet på nyckeln och det önskade värdet måste anges som ytterligare argument:

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

unset

Med detta kommando kan en enda konfigurationsnyckel raderas, dvs. Veyon använder då det interna standardvärdet. Namnet på nyckeln måste anges som ett extra argument:

veyon-cli config unset Directories/Screenshots

upgrade: Med det här kommandot kan konfigurationen av Veyon och alla insticksprogram uppdateras och sparas. Detta kan vara nödvändigt om inställningar eller konfigurationsformat har ändrats på grund av uppdateringar av program eller insticksprogram.

Funktionskontroll

Modulen feature innehåller kommandon för att fråga efter tillgängliga funktioner och styra dem på fjärrdatorer.

list: Visar en lista med namnen på alla tillgängliga funktioner.

show: Visar en tabell med detaljerad information om alla tillgängliga funktioner. Informationen omfattar en beskrivning, UID, namnet på det plugin som tillhandahåller respektive funktion och vissa andra implementeringsrelaterade detaljer.

start <FEATURE> <HOST ADRESS> [<ARGUMENTS>]: Startar den angivna funktionen på den angivna värden genom att ansluta till Veyon Server som körs på distans. Funktionen kan anges med namn eller UID. Använd kommandot show för att se alla tillgängliga funktioner. Beroende på funktionen måste ytterligare argument (t.ex. textmeddelandet som ska visas) kodade som en enda JSON-sträng anges. Se utvecklarens dokumentation för mer information

stop <FEATURE> <HOST ADRESS>: Stoppar den angivna funktionen på den angivna värden genom att ansluta till Veyon-servern som körs på distans. Funktionen kan anges med namn eller UID. Använd kommandot show för att se alla tillgängliga funktioner.

LDAP

De kommandon som finns i modulen ldap dokumenteras i avsnittet Kommandoradsgränssnitt i kapitel LDAP/AD-integration.

Katalog över nätverksobjekt

Som beskrivs i avsnittet Platser och datorer tillhandahåller Veyon en inbyggd nätverksobjektkatalog som kan användas när ingen LDAP-server är tillgänglig. Denna nätverksobjektkatalog kan hanteras både i Veyon Configurator och på kommandoraden. Vissa åtgärder, t.ex. CSV-import, är för närvarande endast tillgängliga på kommandoraden. För de flesta kommandon finns en detaljerad beskrivning med exempel i den kommandospecifika hjälpen. Följande kommandon kan användas i modulen networkobjects:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Detta kommando lägger till ett objekt, där <TYPE> kan vara plats eller dator. <PARENT> kan anges som namn eller UUID.

clear: Detta kommando återställer hela nätverksobjektkatalogen, dvs. alla platser och datorer tas bort. Denna åtgärd är särskilt användbar före en automatiserad import.

dump: Med detta kommando visas hela nätverksobjektkatalogen som en platt tabell. Varje egenskap, t.ex. objektets UID, typ eller namn, visas som en separat kolumn.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]: Detta kommando kan användas för att exportera antingen hela nätverksobjektkatalogen eller endast den angivna platsen till en textfil. Formateringen kan styras via en formatsträng som innehåller platshållarvariabler. Detta gör det möjligt att enkelt generera CSV-filer. Giltiga variabler är %type%, %name%, %host%, %mac% och %location%. Olika exempel ges i kommandohjälpen (veyon-cli networkobjects help export).

Observera

När du använder det här kommandot i batchfiler eller genom schemalagda uppgifter i Windows måste du se till att undkomma procenttecknet på rätt sätt, dvs. använd %%type%% i stället för %type%. Annars kommer de enskilda delarna av formatsträngarna att behandlas som miljövariabler och i de flesta fall ersättas med tomma strängar. Detta kommer att leda till oväntade parse-fel.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: Detta kommando kan användas för att importera en textfil till nätverkets objektkatalog. Bearbetningen av indata kan styras via en formatsträng eller ett reguljärt uttryck som innehåller platshållarvariabler. På så sätt kan både CSV-filer och andra typer av strukturerade data importeras. Giltiga variabler är %type%, %name%, %host%, %mac% och %location%. Olika exempel ges i kommandohjälpen (veyon-cli networkobjects help import).

Observera

När du använder det här kommandot i batchfiler eller genom schemalagda uppgifter i Windows måste du se till att undkomma procenttecknet på rätt sätt, dvs. använd %%type%% i stället för %type%. Annars kommer de enskilda delarna av formatsträngarna att behandlas som miljövariabler och i de flesta fall ersättas med tomma strängar. Detta kommer att leda till oväntade parse-fel.

list: Detta kommando skriver ut hela nätverksobjektkatalogen som en formaterad lista. Till skillnad från kommandot dump representeras hierarkin av platser och datorer av lämplig formatering.

remove <OBJECT>: Detta kommando tar bort det angivna objektet från katalogen. OBJECT kan specificeras med namn eller UUID. Om du tar bort en plats tas även alla relaterade datorer bort.

Power

Modulen power gör det möjligt att använda energirelaterade funktioner från kommandoraden.

on <MAC ADDRESS>: Detta kommando sänder ett WOL-paket (Wake-on-LAN) till nätverket för att slå på datorn med den angivna MAC-adressen.

Fjärråtkomst

Modulen remoteaccess innehåller funktioner för grafisk fjärråtkomst till datorer. Det är samma funktioner som kan nås från Veyon Master. Funktionen som tillhandahålls av kommandoradsverktyget kan t.ex. användas för att skapa en programgenväg för direktåtkomst till en viss dator.

control

Detta kommando öppnar ett fönster med fjärrkontrollfunktionen som kan användas för att styra en fjärrdator. Datorns namn eller IP-adress (och eventuellt TCP-port) måste anges som ett argument:

veyon-cli remoteaccess control 192.168.1.2

view

Detta kommando öppnar ett fönster med fjärrvisningsfunktionen för att övervaka en fjärrdator. I det här läget visas skärminnehållet i realtid, men det går inte att interagera med datorn förrän man har klickat på motsvarande knapp i verktygsfältet. Datorn eller IP-adressen (och eventuellt TCP-porten) måste anges som argument:

veyon-cli remoteaccess view pc5:5900

Servicekontroll

Modulen service kan användas för att styra den lokala Veyon-tjänsten.

register: Det här kommandot registrerar Veyon Service som en tjänst i operativsystemet så att den startas automatiskt när datorn startar.

unregister: Detta kommando tar bort registreringen av tjänsten i operativsystemet så att Veyon-tjänsten inte längre startas automatiskt vid uppstart.

start: Detta kommando startar Veyon-tjänsten.

stop: Detta kommando stoppar Veyon-tjänsten.

restart: Detta kommando startar om Veyon-tjänsten.

status: Detta kommando frågar efter och visar status för Veyon-tjänsten.

Skal

Enkla shell-funktioner tillhandahålls av modulen shell. Om den här modulen anropas utan ytterligare argument startas ett interaktivt läge. I detta läge kan alla CLI-kommandon anges direkt utan att programmet veyon-cli behöver anges och anropas för varje kommando. Läget kan lämnas genom att ange nyckelordet exit.

Dessutom kan modulen användas för automatiserad bearbetning av kommandon i en textfil för att implementera enkel batchbearbetning:

run <FILE>: Detta kommando utför de kommandon som anges i textfilen rad för rad. Operationerna utförs oberoende av resultatet av tidigare operationer, dvs. ett fel leder inte till avslutning.