Interfejs linii komend

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.

Jeśli program zostanie wywołany z parametrem `` help «», wyświetlona zostanie lista wszystkich dostępnych modułów. Lista może się różnić w zależności od zainstalowanych wtyczek:

$ 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

Każdy moduł CLI obsługuje polecenie `` help «», dzięki czemu można wyświetlić listę wszystkich dostępnych poleceń dla każdego modułu. Przykładowe dane wyjściowe dla modułu `` 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

W przypadku niektórych modułów komendę `` help «» można podać z nazwą komendy jako dodatkowy argument, aby uzyskać konkretną pomoc dla komendy:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Zarządzanie kluczami uwierzytelniającymi

Moduł `` authkeys «» umożliwia zarządzanie kluczami uwierzytelniającymi, dzięki czemu można łatwo zautomatyzować typowe operacje, takie jak import klucza uwierzytelniającego lub przypisanie grupy użytkowników.

Informacja

Parametr <KEY> `` zawsze odnosi się do nazwy klucza składającej się z identyfikatora nazwy i typu, np. `` nauczyciel / publiczny. Identyfikator nazwy musi składać się wyłącznie z liter. Typ musi być `` prywatny «» lub `` publiczny «».

create <NAME>: To polecenie tworzy parę kluczy uwierzytelniających z nazwą <NAME>i zapisuje klucz prywatny oraz publiczny w skonfigurowanych katalogach kluczy. Parametr musi być nazwą klucza, która może zawierać tylko litery.

delete <KEY>: To polecenie usuwa klucz uwierzytelniający <KEY>ze skonfigurowanego katalogu kluczy. Pamiętaj, że klucza nie można odzyskać po jego usunięciu.

export <KEY> [<FILE>]: To polecenie eksportuje klucz uwierzytelniania <KEY>do <FILE>. Jeśli <FILE>nie zostanie określony, nazwa zostanie utworzona na podstawie nazwy i typu <KEY>.

extract <KEY>: To polecenie wyodrębnia część klucza publicznego z klucza prywatnego <KEY>i zapisuje ją jako powiązany klucz publiczny. Dlatego podczas konfigurowania innego komputera głównego wystarczy przesłać tylko klucz prywatny. Następnie można wyodrębnić klucz publiczny.

import <KEY> [<FILE>]: To polecenie importuje klucz uwierzytelniający <KEY> z <FILE>. Jeśli <FILE>nie zostanie określony, nazwa <KEY> zostanie utworzona na podstawie nazwy i typu.

list [details]: To polecenie wyświetla listę wszystkich dostępnych kluczy uwierzytelniania w skonfigurowanym katalogu kluczy. Jeśli określono opcję `` szczegóły``, zamiast niej zostanie wyświetlona tabela z kluczowymi szczegółami. Niektórych szczegółów może brakować, jeśli klucz nie jest dostępny, np. z powodu braku uprawnień do odczytu.

setaccessgroup <KEY> <ACCESS GROUP>: To polecenie dostosowuje uprawnienia dostępu do <KEY>w taki sposób, że tylko grupa <ACCESS GROUP> ma do niego dostęp do odczytu.

Zarządzanie konfiguracją

Lokalną konfiguracją Veyon można zarządzać za pomocą modułu `` config``. Zarówno pełną konfigurację jako indywidualne klucze konfiguracyjne można odczytać lub zapisać.

clear: To polecenie resetuje całą konfigurację lokalną, usuwając wszystkie klucze konfiguracji. Użyj tego polecenia, aby odtworzyć zdefiniowany stan bez starych ustawień przed zaimportowaniem konfiguracji.

export

To polecenie eksportuje konfigurację lokalną do pliku. Nazwę pliku docelowego należy podać jako dodatkowy parametr:

veyon-cli config export myconfig.json

import

To polecenie importuje wcześniej wyeksportowany plik konfiguracyjny do konfiguracji lokalnej. Nazwę pliku konfiguracyjnego do zaimportowania należy podać jako dodatkowy argument:

veyon-cli config import myconfig.json

list [defaults | types]: To polecenie wyświetla listę wszystkich kluczy konfiguracyjnych i odpowiadających im wartości. W ten sposób możesz uzyskać nazwy kluczy konfiguracyjnych, aby odczytać lub zapisać je indywidualnie za pomocą poleceń `` get «» lub `` set «». Przy dodatkowym określeniu wartości domyślnych drukowana jest wartość domyślna dla każdego klucza konfiguracyjnego zamiast faktycznie skonfigurowanej wartości. Alternatywnie typy danych kluczy konfiguracyjnych można sprawdzić, wpisując `` types «».

get

To polecenie pozwala odczytać pojedynczy klucz konfiguracji. Nazwa klucza musi zostać podana jako parametr.

veyon-cli config get Network/VeyonServerPort

set

Tego polecenia można użyć do napisania pojedyńczego klucza konfiguracji. Nazwa klucza i żądana wartość muszą zostać przekazane jako dodatkowe argumenty:

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

unset

Za pomocą tego polecenia można usunąć pojedynczy klucz konfiguracyjny, tj. Veyon następnie używa wewnętrznej wartości domyślnej. Nazwę klucza należy podać jako dodatkowy argument:

veyon-cli config unset Directories/Screenshots

upgrade: Za pomocą tego polecenia można zaktualizować i zapisać konfigurację Veyon i wszystkich wtyczek. Może to być konieczne, jeśli ustawienia lub formaty konfiguracji uległy zmianie w wyniku aktualizacji programu lub wtyczki.

Zarządzanie funkcjami

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

list: Wyświetla listę z nazwami wszystkich dostępnych funkcji.

show: Wyświetla tabelę ze szczegółowymi informacjami o wszystkich dostępnych funkcjach. Informacje te obejmują opis, identyfikator UID, nazwę wtyczki zapewniającej odpowiednią funkcję oraz kilka innych szczegółów związanych z implementacją.

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

Polecenia dostępne w module `` ldap`` są udokumentowane w rozdziale: ref:LDAPCLI w rozdziale: ref:LDAP.

Adres obiektu sieciowego

Jak opisano w sekcji: ref: ConfLocationsAndComputers, Veyon zapewnia wbudowany katalog obiektów sieciowych, z którego można korzystać, gdy nie jest dostępny serwer LDAP. Tym katalogiem obiektów sieciowych można zarządzać w programie Veyon Konfigurator, a także w wierszu poleceń. Niektóre operacje, takie jak import CSV, są obecnie dostępne tylko w wierszu poleceń. W przypadku większości poleceń szczegółowy opis z przykładami jest dostępny w pomocy dotyczącej konkretnych poleceń. W module ``networkobjects «» można użyć następujących poleceń:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: To polecenie dodaje obiekt, w którym <TYPE> może być location lub computer. `` <PARENT>`` może być określony jako nazwa lub UUID.

clear: To polecenie resetuje cały katalog obiektów sieciowych, tzn. Wszystkie lokalizacje i komputery są usuwane. Ta operacja jest szczególnie przydatna przed jakimkolwiek automatycznym importem.

dump: To polecenie wyświetla pełny katalog obiektów sieciowych jako płaską tabelę. Każda właściwość, taka jak identyfikator UID obiektu, typ lub nazwa, jest wyświetlana jako osobna kolumna.

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

Informacja

Podczas korzystania z tego polecenia w plikach wsadowych lub podczas zaplanowanych zadań w systemie Windows upewnij się, że poprawnie unikasz znaku procentu, tj. Użyj %%typ%% zamiast ``%typ% ``. W przeciwnym razie poszczególne części ciągów formatu będą traktowane jak zmienne środowiskowe i w większości przypadków zastąpione pustymi ciągami. Doprowadzi to do nieoczekiwanych błędów analizy.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: Tego polecenia można użyć do zaimportowania pliku tekstowego do katalogu obiektów sieciowych. Przetwarzanie danych wejściowych można kontrolować za pomocą ciągu formatu lub wyrażenia regularnego zawierającego zmienne zastępcze. W ten sposób można importować zarówno pliki CSV, jak i inne typy danych strukturalnych. Prawidłowe zmienne to: %typ%, %name% ``, ``%host% ``, ``%mac% `` i ``%location% ``. W pomocy polecenia podano różne przykłady (``veyon-cli networkobjects help import ).

Informacja

Podczas korzystania z tego polecenia w plikach wsadowych lub podczas zaplanowanych zadań w systemie Windows upewnij się, że poprawnie unikasz znaku procentu, tj. Użyj %%typ%% zamiast ``%typ% ``. W przeciwnym razie poszczególne części ciągów formatu będą traktowane jak zmienne środowiskowe i w większości przypadków zastąpione pustymi ciągami. Doprowadzi to do nieoczekiwanych błędów analizy.

list: To polecenie wyświetla pełny katalog obiektów sieciowych jako sformatowaną listę. W przeciwieństwie do polecenia `` dump «» hierarchia lokalizacji i komputerów jest reprezentowana przez odpowiednie formatowanie.

remove <OBJECT>: To polecenie usuwa określony obiekt z katalogu. OBIEKT można określić według nazwy lub UUID. Usunięcie lokalizacji spowoduje również usunięcie wszystkich powiązanych komputerów.

Zasilanie

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

on <MAC ADDRESS>: To polecenie wysyła pakiet Wake-on-LAN (WOL) do sieci w celu włączenia komputera o podanym adresie MAC.

Zdalny dostęp

Moduł `` remoteaccess`` zapewnia funkcje graficznego zdalnego dostępu do komputerów. Są to te same funkcje, do których można uzyskać dostęp od Veyon Master. Funkcja zapewniana przez narzędzie wiersza poleceń może być na przykład użyta do utworzenia skrótu programu do bezpośredniego dostępu do określonego komputera.

control

To polecenie otwiera okno z funkcją zdalnego sterowania, której można użyć do sterowania komputerem zdalnym. Nazwa komputera lub adres IP (i opcjonalnie port TCP) muszą zostać przekazane jako argument:

veyon-cli remoteaccess control 192.168.1.2

view

To polecenie otwiera okno z funkcją zdalnego podglądu w celu monitorowania komputera zdalnego. W tym trybie zawartość ekranu jest wyświetlana w czasie rzeczywistym, ale interakcja z komputerem nie jest możliwa, dopóki nie zostanie kliknięty odpowiedni przycisk na pasku narzędzi. Komputer lub adres IP (i opcjonalnie port TCP) należy podać jako argument:

veyon-cli remoteaccess view pc5:5900

Zarządzenie usługą

Moduł service może być używany do sterowania lokalną usługą Veyon.

register: To polecenie rejestruje usługę Veyon jako usługę w systemie operacyjnym, dzięki czemu jest uruchamiana automatycznie po uruchomieniu komputera.

unregister: To polecenie usuwa rejestrację usługi w systemie operacyjnym, dzięki czemu usługa Veyon nie jest już automatycznie uruchamiana podczas rozruchu.

start: To polecenie uruchamia usługę Veyon.

stop: To polecenie zatrzymuje usługę Veyon.

restart: To polecenie ponownie uruchamia usługę Veyon.

status: To polecenie sprawdza i wyświetla status usługi Veyon.

Powłoka

Proste funkcje powłoki zapewnia moduł `` shell``. Jeśli ten moduł zostanie wywołany bez dalszych argumentów, uruchomiony zostanie tryb interaktywny. W tym trybie wszystkie polecenia CLI można wprowadzać bezpośrednio, bez konieczności określania i wywoływania programu `` veyon-cli`` dla każdego polecenia. Tryb można opuścić, wpisując `` exit``

Ponadto moduł może być wykorzystywany do automatycznego przetwarzania poleceń w pliku tekstowym w celu wdrożenia prostego przetwarzania wsadowego:

run <FILE>: To polecenie wykonuje polecenia określone w pliku tekstowym linia po linii. Operacje są wykonywane niezależnie od wyniku poprzednich operacji, tj. Błąd nie prowadzi do zakończenia.