Vmesnik ukazne vrstice

For administrative tasks, the Veyon Configurator and the command line tool Veyon CLI are available. The program can be started via the command veyon-cli in the command line. On Windows there’s an additional non-console version veyon-wcli which allows automating tasks without irritating command line window popups. If the $PATH (Linux) or %PATH% (Windows) environment variable does not contain the Veyon installation directory, you must first change to the installation directory or prepend the directory to the program name.

Če je program klican s parametrom pomoč, se prikaže seznam vseh razpoložljivih modulov. Seznam se lahko razlikuje glede na nameščene dodatke Veyon:

$ 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

Vsak modul CLI podpira ukaz pomoč, tako da se lahko prikaže seznam vseh razpoložljivih ukazov za vsak modul. Vzorčni izhod za modul 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

Za nekatere module lahko ukaz pomoč dobite z imenom ukaza kot dodatnim argumentom, da dobite posebno pomoč za ukaz:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Upravljanje ključev za preverjanje pristnosti

Modul authkeys omogoča upravljanje s ključi za preverjanje pristnosti, tako da lahko preproste operacije, kot je uvoz ključa za overjanje ali dodeljevanje uporabniške skupine, zlahka avtomatizirate.

Opomba

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>: Ta ukaz ustvari par ključev za preverjanje pristnosti z imenom <NAME> in shrani zasebni in javni ključ v konfigurirane ključne imenike. Parameter mora biti ime za ključ, ki lahko vsebuje le črke.

delete <KEY>: Ta ukaz izbriše ključ za overjanje <KEY> iz nastavljenega imenika ključev. Upoštevajte, da ključa ni mogoče obnoviti, ko je bil izbrisan.

export <KEY> [<FILE>]: Ta ukaz izvozi ključ za preverjanje pristnosti <KEY> v <FILE>. Če <FILE> ni podana, bo ime sestavljeno iz imena in tipa <KEY>.

extract <KEY>: Ta ukaz izdela del javnega ključa iz zasebnega ključa <KEY> in ga shrani kot povezani javni ključ. Pri nastavljanju drugega glavnega računalnika je torej dovolj, da prenesete samo zasebni ključ. Nato se lahko izvleče javni ključ.

import <KEY> [<FILE>]: Ta ukaz uvozi ključ za preverjanje pristnosti <KEY> iz<FILE>. Če <FILE> ni določena, bo ime zgrajeno iz imena in tipa <KEY>.

list [details]: Ta ukaz prikaže vse razpoložljive ključe za preverjanje pristnosti v konfiguriranem ključnem imeniku. Če je podana možnost podrobnosti, se namesto tega prikaže tabela s ključnimi podrobnostmi. Nekateri podatki morda manjkajo, če ključ ni dostopen, npr. zaradi pomanjkanja dovoljenj za branje.

setaccessgroup <KEY> <ACCESS GROUP>: Ta ukaz prilagodi dovoljenja za dostop do datotek <KEY>, tako da ima bralni dostop samo skupina uporabnikov <ACCESS GROUP>.

Upravljanje konfiguracije

Lokalno konfiguracijo Veyona lahko upravljate z modulom config. Tako celotna konfiguracija kot posamezni konfiguracijski ključi se lahko berejo ali zapišejo.

clear: Ta ukaz ponastavi celotno lokalno konfiguracijo z brisanjem vseh konfiguracijskih ključev. Ta ukaz uporabite za ponovno definiranje stanja brez starih nastavitev, preden uvozite konfiguracijo.

export

Ta ukaz izvozi lokalno konfiguracijo v datoteko. Ime ciljne datoteke mora biti podano kot dodatni parameter:

veyon-cli config export myconfig.json

import

Ta ukaz uvozi predhodno izvoženo konfiguracijsko datoteko v lokalno konfiguracijo. Ime konfiguracijske datoteke, ki jo želite uvoziti, morate podati kot dodatni argument:

veyon-cli config import myconfig.json

list [defaults | types]: This command shows a list of all configuration keys and their corresponding values. This way you can get the names of the configuration keys in order to read or write them individually via the get or set commands. When additionally specifying defaults the default value for each configuration key is printed instead of the actual configured value. Alternatively the data types of the configuration keys can be inspected by specifying types.

get

Ta ukaz omogoča branje enega konfiguracijskega ključa. Ime ključa mora biti podano kot parameter.

veyon-cli config get Network/VeyonServerPort

set

Ta ukaz se lahko uporabi za pisanje enega konfiguracijskega ključa. Ime ključa in želena vrednost morata biti podana kot dodatni argumenti:

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

unset

S tem ukazom lahko izbrišete en sam konfiguracijski ključ, tj. Veyon nato uporabi notranjo privzeto vrednost. Ime ključa je treba posredovati kot dodatni argument:

veyon-cli config unset Directories/Screenshots

upgrade: S tem ukazom je mogoče posodobiti in shraniti konfiguracijo Veyona in vseh vtičnikov. To bo morda potrebno, če se nastavitve ali konfiguracijske oblike spremenijo zaradi posodobitev programa ali vtičnika.

Funkcija nadzora

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

Ukazi, ki so na voljo v modulu ldap, so dokumentirani v razdelku :ref :LDAPCLI v poglavju LDAP/AD integracija.

Imenik omrežnih objektov

Kot je opisano v poglavju Lokacije in računalniki, Veyon ponuja vgrajen imenik omrežnih objektov, ki se lahko uporablja, ko ni na voljo strežnika LDAP. Ta omrežni imenik objektov je mogoče upravljati v Veyon konfiguratorju in v ukazni vrstici. Nekatere operacije, kot je uvoz CSV, so trenutno na voljo samo v ukazni vrstici. Za večino ukazov je podroben opis s primeri na voljo v pomoči, ki je specifična za ukaz. Naslednji ukazi se lahko uporabljajo v modulu networkobjects:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Ta ukaz doda objekt, pri čemer je <TYPE> lahko „lokacija“ ali „računalnik“. <PARENT>`` se lahko določi kot ime ali UUID.

clear: Ta ukaz ponastavi celoten imenik omrežnih objektov, tj. odstranijo se vse lokacije in računalniki. Ta operacija je še posebej uporabna pred vsakim samodejnim uvozom.

dump: Ta ukaz izpiše celoten imenik omrežnih objektov kot ravno tabelo. Vsaka lastnost, kot je UID objekta, tip ali ime, se prikaže kot ločen stolpec.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]: This command can be used to export either the complete network object directory or only the specified location to a text file. The formatting can be controlled via a format string containing placeholder variables. This allows generating CSV file easily. Valid variables are %type%, %name%, %host%, %mac% and %location%. Various examples are given in the command help (veyon-cli networkobjects help export).

Opomba

When using this command in batch files or through scheduled tasks on Windows make sure to properly escape the percent sign, i.e. use %%type%% instead of %type%. Otherwise the individual parts of the format strings will be treated as environment variables and substituted with empty strings in most cases. This will lead to unexpected parse errors.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: This command can be used to import a text file into the network object directory. The processing of the input data can be controlled via a format string or a regular expression containing placeholder variables. This way both CSV files and other types of structured data can be imported. Valid variables are %type%, %name%, %host%, %mac% and %location%. Various examples are given in the command help (veyon-cli networkobjects help import).

Opomba

When using this command in batch files or through scheduled tasks on Windows make sure to properly escape the percent sign, i.e. use %%type%% instead of %type%. Otherwise the individual parts of the format strings will be treated as environment variables and substituted with empty strings in most cases. This will lead to unexpected parse errors.

list: Ta ukaz natisne celoten imenik omrežnih objektov kot oblikovan seznam. Za razliko od ukaza dump je hierarhija lokacij in računalnikov predstavljena z ustreznim oblikovanjem.

remove <OBJECT>: Ta ukaz odstrani podani objekt iz imenika. OBJEKT lahko določite z imenom ali UUID. Če odstranite lokacijo, boste odstranili tudi vse povezane računalnike.

Moč

The power module allows using power-related functions from the command line.

on <MAC ADDRESS>: Ta ukaz oddaja paket Wake-on-LAN (WOL) v omrežje, da bi lahko vklopil računalnik z danim naslovom MAC.

Oddaljen dostop

The remoteaccess module provides functions for a graphical remote access to computers. These are the same functions that can be accessed from the Veyon Master. The function provided by the command line tool can be used for example to create an program shortcut for direct access to a specific computer.

control

Ta ukaz odpre okno s funkcijo daljinskega upravljanja, ki se lahko uporablja za nadzor oddaljenega računalnika. Ime računalnika ali naslov IP (in po izbiri vrata TCP) je treba posredovati kot argument:

veyon-cli remoteaccess control 192.168.1.2

view

Ta ukaz odpre okno s funkcijo pogleda na daljavo za nadzor oddaljenega računalnika. V tem načinu se vsebina zaslona prikaže v realnem času, vendar interakcija z računalnikom ni mogoča, dokler se ne klikne ustrezen gumb na orodni vrstici. Računalnik ali naslov IP (in po izbiri vrata TCP) je treba posredovati kot argument:

veyon-cli remoteaccess view pc5:5900

Nadzor storitve

Modul storitev se lahko uporablja za nadzor lokalne Veyon storitve.

register: Ta ukaz registrira storitev Veyon kot storitev v operacijskem sistemu, tako da se samodejno zažene, ko se zažene računalnik.

unregister: This command removes the service registration in the operating system so that the Veyon Service is no longer automatically started at boot time.

start: Ta ukaz zažene storitev Veyon.

stop: Ta ukaz ustavi storitev Veyon.

restart: Ta ukaz ponovno zažene storitev Veyon.

status: Ta ukaz poizveduje in prikaže stanje storitve Veyon.

Lupina

Funkcionalnosti preproste lupine zagotavlja modul lupina. Če je ta modul klican brez dodatnih argumentov, se zažene interaktivni način. V tem načinu lahko vse ukaze CLI vnesete neposredno, ne da bi morali za vsak ukaz klicatii veyon-cli program. Način lahko zapustite tako, da vnesete ključno besedo izhod.

Modul se lahko uporablja tudi za avtomatizirano obdelavo ukazov v tekstovni datoteki tako, da se izvede enostavna paketna obdelava:

run <FILE>: Ta ukaz izvede ukaze, podane v vrstici za vrstico besedilne datoteke. Operacije se izvajajo neodvisno od rezultatov prejšnjih operacij, tj. napaka ne povzroči prekinitve.