Parancssori interfész

Az adminisztratív feladatokhoz elérhető a Veyon Configurator és a parancssoros eszköz Veyon CLI. A program a veyon-cli parancs segítségével indítható a parancssorban. Windows rendszeren további nem-konzolos verzió is van, a veyon-wcli, amely lehetővé teszi a feladatok automatizálását irritáló parancssoros ablakok nélkül. Ha a $PATH (Linux) vagy a %PATH% (Windows) környezeti változó nem tartalmazza a Veyon telepítési könyvtárát, akkor először át kell váltania a telepítési könyvtárba, vagy előre kell tennie a könyvtárat a program neve elé.

Ha a programot a help paraméterrel hívják, akkor megjelenik az összes elérhető modul listája. A lista változhat a telepített Veyon bővítmények alapján.

$ 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

Minden CLI modul támogatja a help parancsot, így minden modulhoz elérhető parancsok listája jeleníthető meg. Példa kimenet a config modulhoz:

$ 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

Néhány modul esetében a help parancs mellé egy parancsnevet is megadhatunk további argumentumként, hogy konkrét segítséget kapjunk a parancshoz:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Hitelesítésikulcs-kezelés

A authkeys modul lehetővé teszi az azonosítási kulcsok kezelését, így könnyedén automatizálhatók olyan gyakori műveletek, mint az azonosítási kulcs importálása vagy egy felhasználói csoport hozzárendelése.

Megjegyzés

A <KEY> paraméter mindig egy kulcsnevet jelöl, amely egy névazonosítóból és egy típusból áll, például tanár/nyilvános. A névazonosító csak betűket tartalmazhat. A típusnak vagy privát-nak, vagy nyilvános-nak kell lennie.

create <NAME>: Ez a parancs egy új hitelesítési kulcspárt hoz létre <NAME> névvel, és menti a privát és a publikus kulcsot a beállított kulcskönyvtárakba. A paraméter a kulcs megnevezése, ami csak betűket tartalmazhat.

delete <KEY>: Ez a parancs törli <KEY> hitelesítési kulcsot a beállított kulcskönyvtárból. Kérem, figyelj arra, hogy törlés után a kulcs már nem állítható vissza.

export <KEY> [<FILE>]: Ez a parancs exportálja a <KEY> kulcsot a <FILE> hitelesítési kulcsba. Ha nem adott meg <FILE>-t, akkor a név és a <KEY> típusa alapján lesz konstruálva egy név.

extract <KEY>: Ez a parancs kicsomagolja a nyilvános kulcsrészt <KEY> privát kulcsból és a megfelelő nyilvános kulcsként menti. Amikor egy másik mesterszámítógépet állítasz be, elegendő csak a privát kulcsot átmásolni. A publikus kulcs ebből már előállítható.

import <KEY> [<FILE>]: Ez a parancs importálja <KEY> hitelesítési kulcsot <FILE> fájlból. Ha <FILE> nincs megadva, akkor <KEY> nevéből és típusából állítunk elő egy nevet.

list [details]: Ez a parancs a beállított kulcskönyvtárban lévő összes elérhető hitelesítési kulcsot felsorolja. Ha a „details” lehetőség meg van adva, egy, a kulcs részleteit tartalmazó táblázat fog megjelenni. Ha a kulcs nem érhető el, például olvasási jogosultságok hiánya miatt, néhány részlete hiányozhat.

setaccessgroup <KEY> <ACCESS GROUP>: Ez a parancs beállítja a fájlhozzáférési jogosultságot <KEY> értékre, így csak <ACCESS GROUP> felhasználói csoportnak van olvasási hozzáférése a fájlhoz.

Konfigurációkezelés

A helyi Veyon konfiguráció a config modullal kezelhető. Mind a teljes konfiguráció, mind az egyedi konfigurációs kulcsok olvashatók vagy írhatók.

clear: Ez a parancs az összes helyi konfigurációt visszaállítja a konfigurációs kulcsok törlésével. Használja ezt a parancsot egy meghatározott állapot újrateremtéséhez régi beállítások nélkül a konfiguráció importálása előtt.

export

Ez a parancs exportálja a helyi konfigurációt egy fájlba. A cél fájl nevét további paraméterként kell megadni.

veyon-cli config export myconfig.json

import

Ez a parancs egy korábban exportált konfigurációs fájlt importálja a helyi konfigurációba. Az importálni kívánt konfigurációs fájl nevét további argumentumként kell megadni:

veyon-cli config import myconfig.json

list [defaults | types]: Ez a parancs megjeleníti az összes konfigurációs kulcsot és azok megfelelő értékeit. Így megtudhatja a konfigurációs kulcsok neveit, hogy azokat egyenként olvashassa vagy írja a „get” vagy „set” parancsokkal. Ha továbbá „defaults” -ot is megad, akkor az egyes konfigurációs kulcsok alapértelmezett értéke helyett az aktuálisan beállított érték kerül kiírásra. A konfigurációs kulcsok adattípusai alternatívaként megvizsgálhatók a „types” megadásával.

get

Ez a parancs lehetővé teszi egyetlen konfigurációs kulcs olvasását. A kulcs nevét paraméterként kell megadni.

veyon-cli config get Network/VeyonServerPort

set

Ez a parancs használható egyetlen konfigurációs kulcs írására. A kulcs nevét és a kívánt értéket további argumentumokként kell átadni.

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

unset

Ezzel a parancsal egyetlen konfigurációs kulcs törölhető, azaz a Veyon az alapértelmezett értéket használja. A kulcs nevét további argumentumként kell átadni.

veyon-cli config unset Directories/Screenshots

upgrade: Ezzel a parancsal frissíthető és menthető a Veyon és az összes bővítmény konfigurációja. Ez szükségessé válhat, ha a beállítások vagy a konfigurációs formátumok megváltoztak a program vagy a bővítmények frissítése miatt.

Szolgáltatásvezérlés

A „feature” modul parancsokat biztosít a rendelkezésre álló funkciók lekérdezéséhez és vezérlésükhöz távoli számítógépeken.

list: Megjelenít egy felsorolást az összes elérhető tulajdonság nevével.

show: Megjelenít egy táblázatot az összes elérhető funkció adataival. Ez tartalmazza a leírást, az UID-t, a funkciót biztosító beépülő modul nevét és néhány egyéb megvalósítással kapcsolatos részletet.

start <FEATURE> <HOST ADRESS> [<ARGUMENTS>]: Elindítja a megadott szolgáltatást a megadott kiszolgálón a távolról futó Veyon-szerverhez való csatlakozással. A szolgáltatás névvel vagy UID-vel adható meg. Az összes elérhető funkció megtekintéséhez használja a show parancsot. A szolgáltatástól függően további argumentumokat (például a megjelenítendő szöveges üzenetet) kell megadni egyetlen JSON-karakterláncként kódolva. További információért tekintse meg a fejlesztői dokumentációt

stop <FEATURE> <HOST ADRESS>: Leállítja a megadott szolgáltatást a megadott kiszolgálón a távoli Veyon-szerverhez való csatlakozással. A szolgáltatás névvel vagy UID-vel adható meg. Az összes elérhető funkció megtekintéséhez használja a show parancsot.

LDAP

A ldap modulban elérhető parancsok dokumentációja megtalálható a Parancssori interfész szakaszban a LDAP/AD integráció fejezetben.

Hálózatobjektum-mappa

Ahogy a Helyszínek és számítógépek szakaszban leírták, a Veyon beépített hálózati objektumkönyvtárat biztosít, amely akkor használható, ha nincs elérhető LDAP szerver. Ezt a hálózati objektumkönyvtárat a Veyon Configuratorban és a parancssorban is kezelhetjük. Bizonyos műveletek, például a CSV importálás jelenleg csak a parancssorban érhetők el. A legtöbb parancs esetén részletes leírás és példák találhatók a parancs-specifikus súgóban. A következő parancsok használhatók a „networkobjects” modulban:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Ez a parancs hozzáad egy objektumot, ahol a <TYPE> lehet location vagy computer. A <PARENT> megadható névként vagy UUID-ként.

clear: Ez a parancs visszaállítja az egész hálózati objektumkönyvtárat, azaz az összes hely és számítógép eltávolításra kerül. Ez a művelet különösen hasznos bármilyen automatizált import előtt.

dump: Ez a parancs a teljes hálózati objektumkönyvtárat egy lapos táblaként jeleníti meg. Minden tulajdonság, például az objektum UID-ja, típusa vagy neve külön oszlopban jelenik meg.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]: Ez a parancs használható a teljes hálózati objektumkönyvtár vagy csak a megadott hely exportálásához egy szöveges fájlba. A formázást egy formátumkarakterlánc tartalmazó helyőrző változók segítségével lehet vezérelni. Ez lehetővé teszi a CSV fájl könnyű generálását. Érvényes változók: %type%, %name%, %host%, %mac% és %location%. Különböző példák találhatók a parancs súgójában (veyon-cli networkobjects help export).

Megjegyzés

Amikor ezt a parancsot batch fájlokban vagy ütemezett feladatokon keresztül használja a Windows rendszerben, győződjön meg arról, hogy megfelelően elkerüli a százalékjelet, azaz használja a %%type%% helyett a %type% kifejezést. Ellenkező esetben a formátum karakterláncok egyes részei környezeti változóként lesznek kezelve, és a legtöbb esetben üres karakterláncokkal helyettesítődnek. Ez váratlan elemzési hibákhoz vezet.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: Ez a parancs használható egy szövegfájl importálására a hálózati objektumkönyvtárba. Az bemeneti adatok feldolgozása vezérelhető egy formátumkarakterlánc vagy egy reguláris kifejezés segítségével, amely tartalmaz helykitöltő változókat. Így mind CSV fájlok, mind más típusú strukturált adatok importálhatók. Érvényes változók: %type%, %name%, %host%, %mac% és %location%. Különböző példák találhatók a parancs súgójában (veyon-cli networkobjects help import).

Megjegyzés

Amikor ezt a parancsot batch fájlokban vagy ütemezett feladatokon keresztül használja a Windows rendszerben, győződjön meg arról, hogy megfelelően elkerüli a százalékjelet, azaz használja a %%type%% helyett a %type% kifejezést. Ellenkező esetben a formátum karakterláncok egyes részei környezeti változóként lesznek kezelve, és a legtöbb esetben üres karakterláncokkal helyettesítődnek. Ez váratlan elemzési hibákhoz vezet.

list: Ez a parancs a teljes hálózati objektumkönyvtárat formázott listaként nyomtatja ki. A helyek és számítógépek hierarchiája megfelelő formázással van ábrázolva, ellentétben a „dump” parancsával.

remove <OBJECT>: Eltávolítja a meghatározott objektumot a mappából. OBJECT értékét a név vagy az UUID határozhatja meg. Egy helyszín eltávolítása a hozzá tartozó összes számítógépet is eltávolítja.

Áramellátás

A „power” modul lehetővé teszi a teljesítménnyel kapcsolatos funkciók használatát a parancssorból.

on <MAC ADDRESS>: Ez a parancs egy hálózati ébresztő jelcsomagot (WOL) szór a hálózaton, hogy a megadott fizikai című számítógépeket bekapcsolja.

Távoli elérés

A remoteaccess modul funkciókat biztosít a számítógépek távoli eléréséhez. Ezek ugyanazok a funkciók, amelyek elérhetők a Veyon Masterből. A parancssoros eszköz által biztosított funkció például használható egy programgyorsító létrehozásához a közvetlen hozzáférés érdekében egy adott számítógéphez.

control

Ez a parancs egy ablakot nyit meg a távoli vezérlési funkcióval, amelyet használhatunk egy távoli számítógép vezérlésére. A számítógép nevét vagy IP-címét (és opcionálisan a TCP portot) argumentumként kell átadni:

veyon-cli remoteaccess control 192.168.1.2

view

Ez a parancs egy ablakot nyit meg a távoli nézet funkcióval, hogy figyelje a távoli számítógépet. Ebben a módban a képernyő tartalma valós időben jelenik meg, de a számítógéppel való interakció csak akkor lehetséges, ha a megfelelő gombot az eszköztáron megnyomták. A számítógép vagy IP-cím (és opcionálisan a TCP-port) argumentumként kell átadni:

veyon-cli remoteaccess view pc5:5900

Szolgáltatásvezérlés

A „service” modult használhatjuk a helyi Veyon szolgáltatás vezérlésére.

register: Ez a parancs regisztrálja a Veyon szolgáltatást szolgáltatásként az operációs rendszerben, így automatikusan elindul a számítógép bekapcsolásakor.

unregister: Ez a parancs eltávolítja a szolgáltatás regisztrációját az operációs rendszerben, így a Veyon szolgáltatás többé nem indul automatikusan a rendszerindításkor.

start: Ez a parancs elindítja a Veyon Szolgáltatást.

stop: Ez a parancs megállítja a Veyon Szolgáltatást.

restart: Ez a parancs újraindítja a Veyon Szolgáltatást.

status: Ez a parancs lekérdezi és megjeleníti a Veyon Szolgáltatás státuszát.

Shell

A „shell” modul biztosítja a egyszerű parancssoros funkciókat. Ha ezt a modult további argumentumok nélkül hívják, interaktív mód indul. Ebben a módban az összes CLI parancs közvetlenül beírható anélkül, hogy minden parancsra külön-külön meg kellene adni és meghívni a „veyon-cli” programot. A módból a „exit” kulcsszó beírásával lehet kilépni.

Ezenkívül a modult használhatjuk parancsok automatikus feldolgozására egy szövegfájlban, hogy egyszerű adagfeldolgozást valósítsunk meg.

run <FILE>: Ez a parancs végrehajtja a szövegfájlban megadott parancsokat soronként. A műveletek függetlenül végrehajtódnak a korábbi műveletek eredményétől, azaz egy hiba nem vezet leálláshoz.