Interfaccia della riga di comando

Per le attività amministrative, sono disponibili Veyon Configurator e lo strumento da riga di comando Veyon CLI. Il programma può essere avviato tramite il comando «veyon-cli» nella riga di comando. Su Windows c’è una versione aggiuntiva non console «veyon-wcli”” che consente di automatizzare le attività senza fastidiosi popup della finestra della riga di comando. Se la variabile di ambiente: envvar: $PATH (Linux) o: envvar:`%PATH% `(Windows) non contiene la directory di installazione di Veyon, è necessario prima passare alla directory di installazione o anteporre la directory al nome del programma .

Se il programma viene chiamato con il parametro `` help``, viene visualizzato un elenco di tutti i moduli disponibili. L’elenco può variare in base ai plug-in Veyon installati:

$ 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

Ogni modulo CLI supporta il comando `` help``, in modo che un elenco di tutti i comandi disponibili possa essere visualizzato per ciascun modulo. Esempio di output per il modulo `` 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

Per alcuni moduli il comando `` help`` può essere fornito con un nome di comando come argomento aggiuntivo per ottenere aiuto specifico per un comando:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Gestione delle chiavi di autenticazione

Il modulo `` authkeys`` consente la gestione delle chiavi di autenticazione in modo che operazioni comuni come l’importazione di una chiave di autenticazione o l’assegnazione di un gruppo di utenti possano essere automatizzate facilmente.

Nota

Il <KEY> parametro si riferisce sempre a un nome chiave costituito da un identificatore di nome e un tipo, ad es. `` Insegnante / public``. Un identificatore di nome deve essere composto solo da lettere. Il tipo deve essere privato o pubblico.

create <NAME>: Questo comando crea una coppia di chiavi di autenticazione con nome <NAME> e salva la chiave privata e pubblica nelle directory delle chiavi configurate. Il parametro deve essere un nome per la chiave, che può contenere solo lettere.

delete <KEY>: Questo comando cancella la chiave di autenticazione <KEY> dalla directory delle chiavi configurata. Si prega di notare che una chiave non può essere recuperata una volta che è stata cancellata.

export <KEY> [<FILE>]: Questo comando esporta il file <KEY> alla <FILE> chiave di autenticazione. Se<FILE>non è specificato un nome verrà costruito dal nome e dal tipo di<KEY>.

extract <KEY>: Questo comando estrae la parte della chiave pubblica dalla chiave privata <KEY> e lo salva come chiave pubblica associata. Quando si configura un altro computer master, è quindi sufficiente trasferire solo la chiave privata. La chiave pubblica può quindi essere estratta.

import <KEY> [<FILE>]: Questo comando importa la chiave di autenticazione. Se non viene specificato un nome sarà costruito dal nome e tipo.

list [details]: Questo comando elenca tutte le chiavi di autenticazione disponibili nella directory delle chiavi configurata. Se viene specificata l’opzione `` dettagli “” verrà invece visualizzata una tabella con i dettagli chiave. Alcuni dettagli potrebbero mancare se una chiave non è accessibile ad es. a causa della mancanza di autorizzazioni di lettura.

setaccessgroup <KEY> <ACCESS GROUP>: Questo comando regola le autorizzazioni di accesso al file <KEY> in modo che solo il gruppo di utenti <ACCESS GROUP> abbia accesso in lettura ad esso.

Gestione della configurazione

La configurazione locale di Veyon può essere gestita usando il modulo `` config``. È possibile leggere o scrivere sia la configurazione completa come singole chiavi di configurazione.

clear: Questo comando ripristina l’intera configurazione locale eliminando tutte le chiavi di configurazione. Utilizzare questo comando per ricreare uno stato definito senza impostazioni precedenti prima di importare una configurazione.

export

Questo comando esporta la configurazione locale in un file. Il nome del file di destinazione deve essere specificato come parametro aggiuntivo:

veyon-cli config export myconfig.json

import

Questo comando importa un file di configurazione precedentemente esportato nella configurazione locale. Il nome del file di configurazione da importare deve essere specificato come argomento aggiuntivo:

veyon-cli config import myconfig.json

list [defaults | types]: Questo comando mostra un elenco di tutte le chiavi di configurazione e i loro valori corrispondenti. In questo modo è possibile ottenere i nomi delle chiavi di configurazione per poterle leggere o scrivere singolarmente tramite i comandi `` get`` o `` set``. Quando si specificano ulteriormente le `` impostazioni predefinite “”, viene stampato il valore predefinito per ciascuna chiave di configurazione anziché il valore configurato effettivo. In alternativa, i tipi di dati delle chiavi di configurazione possono essere controllati specificando `` tipi``.

get

Questo comando consente di leggere una singola chiave di configurazione. Il nome della chiave deve essere fornito come parametro.

veyon-cli config get Network/VeyonServerPort

set

Questo comando può essere utilizzato per scrivere una singola chiave di configurazione. Il nome della chiave e il valore desiderato devono essere passati come argomenti aggiuntivi:

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

unset

Con questo comando è possibile eliminare una singola chiave di configurazione, ovvero Veyon utilizza quindi il valore predefinito interno. Il nome della chiave deve essere passato come argomento aggiuntivo:

veyon-cli config unset Directories/Screenshots

upgrade: Con questo comando è possibile aggiornare e salvare la configurazione di Veyon e di tutti i plugin. Ciò può essere necessario se le impostazioni o i formati di configurazione sono cambiati a causa degli aggiornamenti del programma o dei plug-in.

Controllo delle opzioni

Il modulo funzionalità fornisce comandi per interrogare le funzioni disponibili e controllarle su computer remoti.

list: Visualizza un elenco con i nomi di tutte le funzioni disponibili.

show: Visualizza una tabella con informazioni dettagliate su tutte le funzioni disponibili. Queste informazioni includono una descrizione, l’UID, il nome del plug-in che fornisce la rispettiva funzione e alcuni altri dettagli relativi all’implementazione.

start <FEATURE> <HOST ADRESS> [<ARGUMENTS>]: Avvia la funzione specificata sull’host specificato connettendosi al server Veyon in esecuzione in remoto. La funzione può essere specificata per nome o UID. Usa il comando mostra per vedere tutte le funzionalità disponibili. A seconda della funzionalità, devono essere specificati argomenti aggiuntivi (come il messaggio di testo da visualizzare) codificati come una singola stringa JSON. Si prega di fare riferimento alla documentazione per gli sviluppatori per ulteriori informazioni

stop <FEATURE> <HOST ADRESS>: Arresta la funzione specificata sull’host specificato connettendosi al server Veyon in esecuzione in remoto. La funzione può essere specificata per nome o UID. Usa il comando mostra per vedere tutte le funzionalità disponibili.

LDAP

I comandi disponibili nel modulo `` ldap`` sono documentati nella sezione: ref:LDAPCLI nel capitolo Integrazione LDAP/AD.

Directory dell’oggetto di rete

Come descritto nella sezione Posizioni e computers, Veyon fornisce una directory di oggetti di rete integrata che può essere utilizzata quando non è disponibile alcun server LDAP. Questa directory degli oggetti di rete può essere gestita in Veyon Configurator e dalla riga di comando. Alcune operazioni come l’importazione CSV sono attualmente disponibili solo sulla riga di comando. Per la maggior parte dei comandi, una descrizione dettagliata con esempi è disponibile nella guida specifica del comando. I seguenti comandi possono essere utilizzati nel modulo `` networkobjects``:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Questo comando aggiunge un oggetto, dove <TYPE> può essere locato o il computer. <PARENT> può essere specificato come nome o UUID.

clear: Questo comando reimposta l’intera directory degli oggetti di rete, ovvero tutte le posizioni e i computer vengono rimossi. Questa operazione è particolarmente utile prima di qualsiasi importazione automatizzata.

dump: Questo comando genera l’intera directory degli oggetti di rete come una tabella piatta. Ogni proprietà come UID oggetto, tipo o nome viene visualizzata come una colonna separata.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]: Questo comando può essere utilizzato per esportare l’intera directory degli oggetti di rete o solo la posizione specificata in un file di testo. La formattazione può essere controllata tramite una stringa di formato contenente variabili segnaposto. Ciò consente di generare facilmente file CSV. Le variabili valide sono``%type%``, %name%, %host%, %mac% and %location%. Vari esempi sono forniti nell’help dei comandi (`` veyon-cli networkobjects help export``).

Nota

Quando si utilizza questo comando in file batch o tramite attività pianificate su Windows, assicurarsi di sfuggire correttamente al segno di percentuale, ovvero utilizzare %%type%% invece di %type%.Altrimenti le singole parti delle stringhe di formato verranno trattate come variabili di ambiente e sostituite con stringhe vuote nella maggior parte dei casi. Ciò porterà a errori di analisi imprevisti.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: Questo comando può essere utilizzato per importare un file di testo nella directory degli oggetti di rete. L’elaborazione dei dati di input può essere controllata tramite una stringa di formato o un’espressione regolare contenente variabili segnaposto. In questo modo è possibile importare sia file CSV che altri tipi di dati strutturati. Le variabili valide sono``%type%``, %name%, %host%, %mac% and %location%. Vari esempi sono riportati nella guida di comando (`` veyon-cli networkobjects help import``).

Nota

Quando si utilizza questo comando in file batch o tramite attività pianificate su Windows, assicurarsi di sfuggire correttamente al segno di percentuale, ovvero utilizzare %%type%% invece di %type%.Altrimenti le singole parti delle stringhe di formato verranno trattate come variabili di ambiente e sostituite con stringhe vuote nella maggior parte dei casi. Ciò porterà a errori di analisi imprevisti.

list: Questo comando stampa la directory completa degli oggetti di rete come un elenco formattato. A differenza del comando dump, la gerarchia di posizioni e computer è rappresentata da una formattazione appropriata.

remove <OBJECT>: Questo comando rimuove l’oggetto specificato dalla directory. OBJECT può essere specificato per nome o UUID. La rimozione di una posizione rimuoverà anche tutti i computer correlati.

Potenza

Il modulo power consente di utilizzare le funzioni relative all’alimentazione dalla riga di comando.

on <MAC ADDRESS>: Questo comando trasmette un pacchetto Wake-on-LAN (WOL) alla rete per accendere il computer con l’indirizzo MAC specificato.

Accesso remoto

Il modulo remoteaccess fornisce funzioni per un accesso remoto grafico ai computer. Queste sono le stesse funzioni a cui è possibile accedere da Veyon Master. La funzione fornita dallo strumento da riga di comando può essere utilizzata ad esempio per creare un collegamento al programma per l’accesso diretto a un computer specifico.

control

Questo comando apre una finestra con la funzione di controllo remoto che può essere utilizzata per controllare un computer remoto. Il nome del computer o l’indirizzo IP (e facoltativamente la porta TCP) devono essere passati come argomento:

veyon-cli remoteaccess control 192.168.1.2

view

Questo comando apre una finestra con la funzione di visualizzazione remota per monitorare un computer remoto. In questa modalità il contenuto dello schermo viene visualizzato in tempo reale, ma l’interazione con il computer non è possibile finché non si fa clic sul pulsante corrispondente sulla barra degli strumenti. Il computer o l’indirizzo IP (e facoltativamente la porta TCP) devono essere passati come argomento:

veyon-cli remoteaccess view pc5:5900

Controllo del servizio

Il modulo service può essere utilizzato per controllare il servizio Veyon locale.

register: Questo comando registra Veyon Service come servizio nel sistema operativo in modo che venga avviato automaticamente all’avvio del computer.

unregister: Questo comando rimuove la registrazione del servizio nel sistema operativo in modo che il servizio Veyon non venga più avviato automaticamente all’avvio.

start: Questo comando avvia il servizio Veyon.

stop: Questo comando interrompe il servizio Veyon.

restart: Questo comando riavvia il servizio Veyon.

status: Questo comando richiede e visualizza lo stato del servizio Veyon.

Shell

Le semplici funzionalità della shell sono fornite dal modulo shell. Se questo modulo viene chiamato senza ulteriori argomenti, viene avviata una modalità interattiva. In questa modalità, tutti i comandi CLI possono essere inseriti direttamente senza dover specificare e chiamare il programma veyon-cli per ciascun comando. La modalità può essere abbandonata inserendo la parola chiave exit.

Inoltre, il modulo può essere utilizzato per l’elaborazione automatizzata di comandi in un file di testo al fine di implementare una semplice elaborazione batch:

run <FILE>: Questo comando esegue riga per riga i comandi specificati nel file di testo. Le operazioni vengono eseguite indipendentemente dal risultato di operazioni precedenti, ovvero un errore non porta alla conclusione.