Käsurea liides

Haldusülesannete jaoks on saadaval Veyon Configurator ja käsurea tööriist Veyon CLI. Programmi saab käivitada käsureal oleva käsu „veyon-cli“ kaudu. Windowsis on täiendav konsooliväline versioon „veyon-wcli“, mis võimaldab toiminguid automatiseerida ilma käsurea akna hüpikuid ärritamata. Kui keskkonnamuutuja $ PATH (Linux) või :envvar:`% PATH% `(Windows) ei sisalda Veyoni installikataloogi, peate esmalt muutma installikataloogi või lisama kataloogi programmi nimele .

Kui programmi kutsutakse parameetriga help, kuvatakse kõigi saadaolevate moodulite loend. Nimekiri võib varieeruda sõltuvalt installitud Veyoni pistikprogrammidest:

$ 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

Iga CLI moodul toetab käsku help, nii et iga mooduli jaoks saab kuvada kõigi saadaolevate käskude loendi. Konfigureerimise mooduli näidiväljund:

$ 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

Mõne mooduli jaoks saab käsule spikri lisateabe saamiseks käsu help anda käsu nimega:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Autentimisvõtmete haldamine

Moodul Autentsed võtmed võimaldab autentimisvõtmete haldamist, nii et tavalisi toiminguid, näiteks autentimisvõtme importimist või kasutajagrupi määramist, saab hõlpsasti automatiseerida.

Märkus

Parameeter <KEY> viitab alati võtme nimele, mis koosneb nime identifikaatorist ja tüübist, näit „õpetaja/avalik“. Nime identifikaator peab koosnema ainult tähtedest. Tüüp peab olema kas privaatne või avalik.

create <NAME>

See käsk loob nimega autentimisvõtmepaari <NAME> ja salvestab konfigureeritud võtmekataloogidesse privaatse ja avaliku võtme. Parameeter peab olema võtme nimi, mis võib sisaldada ainult tähti.

delete <KEY>

See käsk kustutab autentimisvõtme <KEY> konfigureeritud võtmete kataloogist. Pange tähele, et võtit ei saa pärast selle kustutamist taastada.

export <KEY> [<FILE>]

See käsk ekspordib <KEY> > <FILE> autentimisvõtme. Kui <FILE> pole täpsustatud, koostatakse nimi nime ja tüübi järgi <KEY>.

extract <KEY>

See käsk eraldab avaliku võtme osa privaatvõtmest <KEY> ja salvestab selle seotud avaliku võtmena. Teise põhiarvuti seadistamisel piisab seetõttu ainult privaatvõtme edastamisest. Seejärel saab avaliku võtme välja tõmmata.

import <KEY> [<FILE>]

See käsk impordib autentimisvõtme <KEY> kohast <FILE>. Kui <FILE>pole täpsustatud, koostatakse nimi nime ja tüübi <KEY> järgi.

list [details]

See käsk loetleb kõik saadaolevad autentimisvõtmed konfigureeritud võtmete kataloogis. Kui suvand Üksikasjad on määratud, kuvatakse selle asemel peamiste üksikasjadega tabel. Mõned võtmed võivad puududa, kui võtmele pole juurdepääsu, näit. lugemisõiguste puudumise tõttu.

setaccessgroup <KEY> <ACCESS GROUP>

See käsk reguleerib failile juurdepääsuõigused <KEY> nii, et ainult kasutajagrupil <ACCESS GROUP> on sellele lugemisõigus.

Konfiguratsiooni juhtimine

Kohaliku Veyoni konfiguratsiooni saab hallata mooduli config abil. Mõlemat täielikku konfiguratsiooni üksikute konfiguratsioonivõtmetena saab lugeda või kirjutada.

clear

See käsk lähtestab kogu kohaliku konfiguratsiooni, kustutades kõik konfiguratsioonivõtmed. Selle käsu abil saate enne konfiguratsiooni importimist uuesti luua määratud oleku ilma vanade säteteta.

export

See käsk ekspordib kohaliku konfiguratsiooni faili. Sihtfaili nimi tuleb määrata täiendava parameetrina:

veyon-cli config export myconfig.json
import

See käsk impordib varem eksporditud konfiguratsioonifaili kohalikku konfiguratsiooni. Imporditava konfiguratsioonifaili nimi tuleb määrata täiendava argumendina:

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

See käsk näitab kõigi konfiguratsioonivõtmete ja nende vastavate väärtuste loendit. Nii saate konfiguratsioonivõtmete nimed, et neid käskude get või set abil eraldi lugeda või kirjutada. Vaikeväärtuste täiendava määramise korral prinditakse iga konfiguratsioonivõtme vaikeväärtus tegeliku konfigureeritud väärtuse asemel. Teise võimalusena saab konfigureerimisvõtmete andmetüüpe kontrollida, määrates tüübid.

get

See käsk võimaldab lugeda ühte konfiguratsioonivõtit. Parameetrina tuleb sisestada võtme nimi.

veyon-cli config get Network/VeyonServerPort
set

Selle käsu abil saab kirjutada ühe konfiguratsioonivõtme. Võtme nimi ja soovitud väärtus tuleb edastada täiendavate argumentidena:

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

Selle käsuga saab kustutada ühe konfiguratsioonivõtme, st Veyon kasutab seejärel sisemist vaikeväärtust. Täiendava argumendina tuleb edastada võtme nimi:

veyon-cli config unset Directories/Screenshots
upgrade

Selle käsuga saab Veyoni konfiguratsiooni ja kõiki pistikprogramme värskendada ja salvestada. See võib olla vajalik, kui seaded või konfiguratsioonivormingud on programmi või pistikprogrammi värskenduste tõttu muutunud.

Funktsiooni juhtimine

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

list

Displays a list with the names of all available features.

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

Moodulis ldap saadaolevad käsud on dokumenteeritud jaotises LDAP CLI peatükis LDAP/AD integreerimine.

Võrguobjektide kataloog

Nagu on kirjeldatud jaotises :ref: ConfLocationsAndComputers, pakub Veyon sisseehitatud võrguobjektide kataloogi, mida saab kasutada, kui LDAP-server pole saadaval. Seda võrguobjektide kataloogi saab hallata nii Veyon Configuratoris kui ka käsureal. Teatud toimingud, näiteks CSV-failide importimine, on praegu saadaval ainult käsureal. Enamiku käskude jaoks on üksikasjalik kirjeldus koos näidetega käsupõhises spikris. Moodulis networkobjects saab kasutada järgmisi käske:

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

See käsk lisab objekti, kus <TYPE> võib olla „asukoht“ või „arvuti“. <PARENT> saab määrata nime või UUID-na.

clear

See käsk lähtestab kogu võrguobjektide kataloogi, st kõik asukohad ja arvutid eemaldatakse. See toiming on eriti kasulik enne automaatset importimist.

dump

See käsk väljastab kogu võrguobjektide kataloogi kindla tabelina. Iga atribuut, näiteks objekti UID, tüüp või nimi, kuvatakse eraldi veeruna.

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

Seda käsku saab kasutada kas kogu võrguobjektide kataloogi või ainult määratud asukoha eksportimiseks tekstifaili. Vormindust saab juhtida vormindusstringi abil, mis sisaldab kohahoidjate muutujaid. See võimaldab hõlpsasti CSV-faili genereerida. Kehtivad muutujad on %type%, %name%, %host%, %mac% and %location%. Erinevad näited on toodud käsu spikris („veyon-cli võrguobjektid aitavad eksportida“).

Märkus

Selle käsu kasutamisel pakettfailides või Windowsi ajastatud ülesannete kaudu veenduge, et pääsete protsendimärgist korralikult välja, st kasutage %%type%%``asemel ``%type%. Vastasel juhul käsitletakse vormingustringide üksikuid osi keskkonnamuutujatena ja asendatakse need enamasti tühjade stringidega. See toob kaasa ootamatuid sõelumisvigu.

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

Seda käsku saab kasutada tekstifaili importimiseks võrguobjektide kataloogi. Sisendandmete töötlemist saab juhtida vormindusstringi või kohatäite muutujaid sisaldava regulaaravaldise abil. Nii saab importida nii CSV-faile kui ka muud tüüpi struktureeritud andmeid. Kehtivad muutujad on %type%, %name%, %host%, %mac% ja %location%.Erinevad näited on toodud käsu spikris („veyon-cli networkobjects help import“).

Märkus

Selle käsu kasutamisel pakettfailides või Windowsi ajastatud ülesannete kaudu veenduge, et pääsete protsendimärgist korralikult välja, st kasutage %%type%%``asemel ``%type%. Vastasel juhul käsitletakse vormingustringide üksikuid osi keskkonnamuutujatena ja asendatakse need enamasti tühjade stringidega. See toob kaasa ootamatuid sõelumisvigu.

list

See käsk prindib kogu võrguobjektide kataloogi vormindatud loendina. Erinevalt käsust dump esindab asukohtade ja arvutite hierarhiat sobiv vormindus.

remove <OBJECT>

See käsk eemaldab määratud objekti kataloogist. OBJEKTI saab määrata nime või UUID-i järgi. Asukoha eemaldamine eemaldab ka kõik seotud arvutid.

Toide

Moodul „toide“ võimaldab kasutada käsurealt toitega seotud funktsioone.

on <MAC ADDRESS>

See käsk edastab võrgus Wake-on-LAN (WOL) paketi, et antud MAC-aadressiga arvuti sisse lülitada.

Kaugjuurdepääs

Moodul kaugjuurdepääs pakub funktsioone arvutite graafilise kaugjuurdepääsu jaoks. Need on samad funktsioonid, millele pääseb juurde Veyon Masterilt. Käsurea tööriista pakutavat funktsiooni saab kasutada näiteks programmi otsetee loomiseks otseseks juurdepääsuks konkreetsele arvutile.

control

See käsk avab kaugjuhtimisfunktsiooniga akna, mida saab kasutada kaugarvuti juhtimiseks. Argumendina tuleb edastada arvuti nimi või IP-aadress (ja soovi korral ka TCP-port):

veyon-cli remoteaccess control 192.168.1.2
view

See käsk avab kaugarvuti jälgimiseks akna kaugvaate funktsiooniga. Selles režiimis kuvatakse ekraani sisu reaalajas, kuid arvutiga suhtlemine pole võimalik enne, kui vastaval nupul tööriistaribal on klõpsatud. Argumendina tuleb edastada arvuti või IP-aadress (ja soovi korral ka TCP-port):

veyon-cli remoteaccess view pc5:5900

Teenuse kontroll

Moodulit teenus saab kasutada kohaliku Veyoni teenuse juhtimiseks.

register

See käsk registreerib Veyoni teenuse operatsioonisüsteemi teenusena, nii et see käivitatakse automaatselt arvuti käivitamisel.

unregister

See käsk eemaldab teenuse registreerimise operatsioonisüsteemist, nii et Veyoni teenust ei käivitata enam käivitamise ajal automaatselt.

start

See käsk käivitab teenuse Veyon.

stop

See käsk peatab Veyoni teenuse.

restart

See käsk taaskäivitab Veyoni teenuse.

status

See käsk küsib ja kuvab Veyoni teenuse oleku.

Kest

Lihtsad kestafunktsioonid pakub moodul shell. Kui seda moodulit kutsutakse ilma täiendavate argumentideta, käivitatakse interaktiivne režiim. Selles režiimis saab kõik CLI-käsud sisestada otse, ilma et peaksite määrama ja kutsuma iga käsu jaoks programmi veyon-cli. Režiimist saab lahkuda, sisestades märksõna exit.

Lisaks saab moodulit kasutada käskude automatiseeritud töötlemiseks tekstifailis, et rakendada lihtsat pakett-töötlust:

run <FILE>

See käsk täidab tekstifailis määratud käsud rea kaupa. Toimingud viiakse läbi sõltumata eelmiste toimingute tulemustest, see tähendab, et viga ei vii lõpetamiseni.