Interfejs komandne linije

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.

Ako se program poziva pomoću parametra „help”, prikazuje se lista svih dostupnih modula. Lista može varirati u zavisnosti od instaliranih Veyon dodataka:

$ 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

Svaki CLI modul podržava naredbu „help” tako da se za svaki modul može prikazati lista svih dostupnih naredbi. Uzorak izlaza za „config” modul:

$ 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 neke module naredba „help” može se dobiti sa imenom naredbe kao dodatni argument da bi se dobila posebna pomoć za naredbu:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Upravitelj ključa za provjeru atentifikacije

Modul „authkeys” omogućava upravljanje ključevima za autentifikaciju tako da se uobičajene operacije poput uvoza ključa za autentifikaciju ili dodeljivanja korisničke grupe mogu biti lako automatizovane

Белешка

Parametar „<KEY>” se uvek odnosi na ime ključa koji se sastoji od identifikatora imena i vrste, npr. „nastavnik/javni”. A name identifier must consist of letters only. Identifikator imena mora se sastojati samo od slova. Tip mora biti „privatni” ili „javni”.

create <NAME>: Ova naredba stvara par ključeva za autentifikaciju sa imenom <NAME> i sprema privatni i javni ključ u konfigurirane direktorijume ključeva. Parametar mora biti ime ključa koji može sadržavati samo slova.

delete <KEY>: Ova naredba briše ključ za proveru autentičnosti <KEY> iz konfiguracionog direktorija ključeva. Imajte na umu da ključ nije moguće vratiti nakon što ga izbrišete.

export <KEY> [<FILE>]: Ova komanda izvozi <KEY> u <FILE> ključ autentifikacije. Ako <FILE> nije određeno ime će biti konstruisano iz imena i tipa od <KEY>.

extract <KEY>: Ova naredba izvlači deo javnog ključa iz privatnog ključa <KEY> i čuva ga kao pridruženi javni ključ. Pri podešavanju drugog glavnog računara dovoljno je prenijeti samo privatni ključ. Javni ključ se zatim može izvući.

import <KEY> [<FILE>]: Ova komanda uvozi autentičnost ključa <KEY> od <FILE>.Ako <FILE> nije specifičan ime će biti konstruisano od imena i tipa <KEY>.

list [details]: Ova naredba navodi sve dostupne ključeve za autentifikaciju u konfiguriranom direktorijumu ključeva. Ako je navedena opcija „details”, umesto nje će se prikazati tabela sa ključnim detaljima. Neki detalji možda nedostaju ako ključ nije dostupan, npr. zbog nedostatka dozvola za čitanje.

setaccessgroup <KEY> <ACCESS GROUP>: Ova naredba prilagođava dozvole za pristup datoteci na <KEY> tako da samo korisnička grupa <ACCESS GROUP> ima pristup čitanja istoj.

Upravitelj konfiguracijom

Lokalnom Veyon konfiguracijom može se upravljati pomoću modula „config”. Oba kompletna konfiguracija kao pojedinačni konfiguracioni ključevi mogu se čitati ili pisati.

clear: Ova naredba resetira celu lokalnu konfiguraciju brisanjem svih konfiguracijskih ključeva. Ovom naredbom ponovo stvarate definisano stanje bez starih postavki pre uvoza konfiguracije.

export

Ova naredba izvozi lokalnu konfiguraciju u datoteku. Naziv odredišne datoteke mora biti naveden kao dodatni parametar:

veyon-cli config export myconfig.json

import

Ova naredba uvozi prethodno izvezenu konfiguracijsku datoteku u lokalnu konfiguraciju. Ime konfiguracione datoteke koja se uvozi mora biti navedena kao dodatni argument:

veyon-cli config import myconfig.json

list [defaults | types]: Ova naredba prikazuje listu svih konfiguracionih ključeva i njihovih odgovarajućih vrednosti. Na ovaj način možete dobiti imena konfiguracijskih ključeva kako biste ih pojedinačno pročitali ili upisali pomoću komandi „get” ili „set”. Kada dodatno navedete „defaults”, štampa se zadana vrednost za svaki konfiguracioni ključ umesto trenutne konfigurisane vrednosti. Alternativno tipovi podataka konfiguracionih ključeva mogu se pregledati navođenjem „types”.

get

Ova naredba omogućava čitanje jednog konfiguracijskog ključa. Naziv ključa mora biti naveden kao parametar.

veyon-cli config get Network/VeyonServerPort

set

Ova naredba se može koristiti za pisanje jednog konfiguracijskog ključa. Naziv ključa i željena vrednost moraju se dodati kao 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

Pomoću ove naredbe jedan konfiguracioni ključ se može izbrisati, tj. Veyon tada koristi unutrašnju zadanu vrednost. Naziv ključa mora se dodati kao dodatni argument:

veyon-cli config unset Directories/Screenshots

upgrade: Ovom naredbom konfiguracija Veyon-a i svih dodataka može se ažurirati i sačuvati. Ovo može biti potrebno ako su se postavke ili konfiguracioni formati promenili zbog ažuriranja programa ili dodatka.

Kontrola funkcija

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

Naredbe dostupne u modulu ldap dokumentuju se u odeljku ref:LDAPCLI u poglavlju LDAP/AD integracija.

Mrežni direktorijum objekata

Kao što je opisano u odeljku Lokacije & računari, Veyon pruža ugrađeni direktorij mrežnih objekata koji se može koristiti kada nije dostupan LDAP server. Ovim direktorijom mrežnih objekata može se upravljati u Veyon Configurator-u, kao i u komandnoj liniji. Određene operacije kao što je uvoz CSV-a trenutno su dostupne samo u komandnoj liniji. Za većinu naredbi detaljan opis sa primerima dostupan je u pomoći specifičnoj za komande. Sledeće naredbe se mogu koristiti u modulu ``networkobjects`:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Ova komanda dodaje objekt, gde <TYPE> može biti location ili computer. <PARENT> se može navesti kao ime ili UUID.

clear: Ova naredba resetira celokupni mrežni direktorij objekata, tj. uklanjaju se sve lokacije i računari. Ova operacija je posebno korisna pre bilo kog automatizovanog uvoza.

dump: Ova naredba prikazuje kompletnu mrežnu mapu objekata kao ravnu tablicu. Svako svojstvo, poput UID-a objekta, tipa ili imena, prikazuje se kao posebna kolona.

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).

Белешка

Kada koristite ovu naredbu u batch datotekama ili kroz zakazane zadatke u Windows provjerite je li pravilno izbjegao znak postotka, tj. koristite %%type%% umesto %type%. U suprotnom će se pojedini delovi stringova formata u većini slučajeva tretirati kao promenljive okoline i zameniti ih praznim nizovima. To će dovesti do neočekivanih grešaka pri raščlanjivanju.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: Ova naredba se može koristiti za uvoz tekstualne datoteke u direktorij mrežnih objekata. Obrada ulaznih podataka može se kontrolisati putem string formata ili regularnog izraza koji sadrži placeholder promenljive. Na ovaj način se mogu uvesti i CSV datoteke i druge vrste strukturiranih podataka. Važeće promenljive su %type%, %name%, %host%, %mac% i %location%. U naredbi help nalaze se različiti primeri (veyon-cli networkobjects help import).

Белешка

Kada koristite ovu naredbu u batch datotekama ili kroz zakazane zadatke u Windows provjerite je li pravilno izbjegao znak postotka, tj. koristite %%type%% umesto %type%. U suprotnom će se pojedini delovi stringova formata u većini slučajeva tretirati kao promenljive okoline i zameniti ih praznim nizovima. To će dovesti do neočekivanih grešaka pri raščlanjivanju.

list: Ova naredba štampa kompletnu mrežnu mapu objekata kao formatiranu listu. Za razliku od dump naredbe, hijerarhija lokacija i računara predstavljena je odgovarajućim oblikovanjem.

remove <OBJECT>: Ova naredba uklanja navedeni objekt iz direktorija. OBJECT se može specificirati imenom ili UUID-om. Ako uklonite lokaciju, takođe ćete ukloniti sve povezane računare.

Palenje

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

on <MAC ADDRESS>: Ova komanda emituje Wake-on-LAN (WOL) paket na mreži da bi bio uključen kompjuter sa datom MAC adresom.

Udaljeni pristup

Modul remoteaccess pruža funkcije za grafički daljinski pristup računarima. To su iste funkcije kojima se može pristupiti iz Veyon Master-a. Funkcija koju pruža alat naredbenog retka može se koristiti na primer za kreiranje programske prečice za direktan pristup određenom računaru.

control

Ova naredba otvara prozor sa funkcijom daljinskog upravljanja koja se može koristiti za kontrolu udaljenog računara. Ime računara ili IP adresa (i opciono TCP port) moraju biti navedeni kao argument:

veyon-cli remoteaccess control 192.168.1.2

view

Ova naredba otvara prozor sa funkcijom daljinskog pregleda za nadgledanje udaljenog računara. U ovom režimu sadržaj na ekranu se prikazuje u realnom vremenu, ali interakcija sa računarom nije moguća dok se ne klikne odgovarajuće dugme na traci sa alatkama. Računar ili IP adresa (i opciono TCP port) treba da se navede kao argument:

veyon-cli remoteaccess view pc5:5900

Kontrola servisa

Modul service može se koristiti za kontrolu lokalne usluge Veyon.

register: Ova komanda registruje Veyon Service kao servis u operativnom sistemu tako da se automatski pokreće kada se računar pokrene.

unregister: Ova naredba uklanja registraciju usluge u operativnom sistemu tako da se Veyon Service više ne pokreće automatski prilikom pokretanja sistema.

start: Ova komanda pokreće Veyon Service.

stop: Komanda zaustavlja Veyon Service.

restart: Ova komanda restarta Veyon Service.

status: Ova komanda ispituje i prikazuje status Veyon Service-a.

Ljuska-omotač

Jednostavne funkcionalnosti ljuske obezbeđuje modul shell. Ako se ovaj modul poziva bez dodatnih argumenata, pokreće se interaktivni mod. U ovom režimu se sve CLI komande mogu unositi direktno bez potrebe za specifikacijom i pozivanjem programa veyon-cli za svaku naredbu. Režim se može napustiti unosom ključne reči exit.

Nadalje, modul se može koristiti za automatiziranu obradu naredbi u tekstualnoj datoteci kako bi se implementirala jednostavna batch obrada:

run <FILE>: Ova naredba izvršava naredbe određene u tekstualnoj datoteci liniju po liniju. Operacije se izvode nezavisno od rezultata prethodnih operacija, tj. greška ne vodi prekidu.