命令列介面

對於管理工作,可以使用 Veyon 組態器 和命令列工具 Veyon CLI 。 程式可以透過命令列中的 veyon-cli 命令啟動。在 Windows ,有一個額外的非主控台版本 veyon-wcli,其允許自動執行工作,而不會出現惱人的命令列視窗快顯視窗。 如果 $PATH (Linux) 或 %PATH% (Windows) 環境變數不包含 Veyon 安裝目錄,則必須先變更為安裝目錄或將目錄預設為程式名稱。

如果使用 help 參數呼叫程式,將顯示所有可用模組的清單。 清單會根據已安裝的 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

每個 CLI 模組都支援 help 命令,以便可以顯示每個模組的所有可用命令清單。 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

對於某些模組,help 命令可以隨命令名稱一起提供,作為取得命令特定說明的附加參數:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

身份驗證金鑰管理

authkeys 模組允許管理身份驗證金鑰,以便輕鬆自動執行常見操作,如匯入身份驗證金鑰或分配使用者群組。

備註

<KEY> 參數始終參照由名稱識別碼和類型組成的金鑰名稱,例如 teacher/public。 名稱識別碼必須只包含字母。 類型必須為 privatepublic

create <NAME>

這個命令建立具有名稱 <NAME> 的身份驗證金鑰組,並將私密金鑰和公開金鑰儲存到組態的金鑰目錄。 參數必須是金鑰的名稱,其只能包含字母。

delete <KEY>

這個命令從組態的金鑰目錄中刪除身份驗證金鑰 <KEY>。 請注意,金鑰刪除後將無法恢復。

export <KEY> [<FILE>]

這個命令將 匯出 <KEY> 到 <FILE> 身份驗證金鑰。 如果未指定 <FILE>,則名稱將從 <KEY> 的名稱和類型構造。

extract <KEY>

這個命令從私密金鑰中擷取公開金鑰 <KEY> 部分,並將其儲存為關聯的公開金鑰。 因此,在設定另一部主電腦時,只需傳輸私密金鑰,然後可以擷取公開金鑰。

import <KEY> [<FILE>]

這個命令從 <FILE> 匯入身分驗證金鑰 <KEY>。 如果未指定 <FILE>,則名稱將從 <KEY> 的名稱和類型構造。

list [details]

這個命令列出組態的金鑰目錄中所有可用的身份驗證金鑰。 如果指定了 details 選項,則將顯示一個含有金鑰詳細資訊的表格。 如果無法存取金鑰 (例如,由於缺少讀取權限),則可能缺少某些詳細資訊。

setaccessgroup <KEY> <ACCESS GROUP>

這個命令將檔案存取權限調整為 <KEY>,以便只有使用者群組 <ACCESS GROUP> 有對該檔案的讀取存取權限。

組態管理

可以使用 config 模組管理本機 Veyon 組態。 可以讀取或寫入作為單獨組態金鑰的完整組態。

clear

這個命令以刪除所有組態金鑰來重設整個本機組態。 使用這個命令在匯入組態前重新建立沒有舊設定的已定義狀態。

export

這個命令將本機組態匯出到檔案。 目的地檔案的名稱必須指定為附加參數:

veyon-cli config export myconfig.json
import

這個命令將以前匯出的設定檔匯入本機組態。 要匯入的組態檔名稱必須指定為附加參數:

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

這個命令顯示所有組態金鑰及其相應值的清單。 如此,您可以取得組態金鑰的名稱,以便透過 getset 命令單獨讀取或寫入它們。 當另外指定 預設值 時,將列印每個組態金鑰的預設值,而不是實際組態的值。 或者,可以透過指定 類型 來檢查組態金鑰的資料類型。

get

這個命令允許讀取單一組態金鑰。 金鑰的名稱必須作為參數提供。

veyon-cli config get Network/VeyonServerPort
set

這個命令可用於編寫單一組態金鑰。 必須作為附加參數傳遞金鑰的名稱和所需值:

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

使用這個命令可以刪除單一組態金鑰,即 Veyon 接著使用內部預設值。 必須將金鑰的名稱作為附加參數傳遞:

veyon-cli config unset Directories/Screenshots
upgrade

使用這個命令,可以更新和儲存 Veyon 及所有外掛程式的組態。 如設定或組態格式因程式或外掛程式更新而變更,則可能需要如此做。

功能控制

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

ldap 模組中可用的命令記錄在章節 LDAP/AD 整合命令列介面 區。

網路物件目錄

位置 & 電腦 區所述,Veyon 提供一個內建的網路物件目錄,可在沒有 LDAP 伺服器可用時使用。 這個網路物件目錄可以在 Veyon 組態器以及命令列進行管理。 某些操作 (如 CSV 匯入) 目前只在命令列可用。 對於大多數命令,在特定命令的 help 中提供了包含範例的詳細說明。 以下命令可用於 networkobjects 模組:

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

這個命令加入一個物件,其中 <TYPE> 可以是 locationcomputer。 能以名稱或 UUID 指定 <PARENT>

clear

這個命令重設整個網路物件目錄,即刪除所有位置和電腦。 這個操作在任何自動匯入前特別有用。

dump

這個命令將整個網路物件目錄輸出為平面表。 每個內容 (如: 物件 UID、類型或名稱) 顯示為單獨欄。

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

這個命令可用於將完整的網路物件目錄或僅指定的位置匯出到文字檔。 可以透過包含預留位置變數的格式字串控制格式。 這允許輕鬆產生 CSV 檔。 有效變數是 %type%, %name%, %host%, %mac%%location%。 命令說明中提供了各種範例 (veyon-cli networkobjects help export)。

備註

在批次檔或透過 Windows 的排程工作使用這個命令時,請確保正確轉譯百分比符號,即使用 %%type%% 而不是 %type%。 否則,格式字串的各個部分將視為環境變數,在大多數情況下將替換為空的字串。 這將造成意外的解析錯誤。

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

這個命令可用於將文字檔匯入網路物件目錄。 輸入資料的處理可以透過格式字串或包含預留位置變數的正則運算式進行控制。 如此,CSV 檔和其它類型的結構化資料都可以匯入。 有效變數是 %type%, %name%, %host%, %mac%%location%。 命令 help 中提供了各種範例 (veyon-cli networkobjects help import)。

備註

在批次檔或透過 Windows 的排程工作使用這個命令時,請確保正確轉譯百分比符號,即使用 %%type%% 而不是 %type%。 否則,格式字串的各個部分將視為環境變數,在大多數情況下將替換為空的字串。 這將造成意外的解析錯誤。

list

這個命令將整個網路物件目錄列印為格式化清單。 與 dump 命令不同,位置和電腦的層次結構由適當的格式表示。

remove <OBJECT>

這個命令從目錄中移除指定的物件。 物件可以依名稱或 UUID 指定。 移除位置也將移除所有相關的電腦。

電源

power 模組允許使用來自命令列與電源相關的功能。

on <MAC ADDRESS>

這個命令將 Wake-on-LAN (WOL) 封包廣播到網路,以便使用給予的 MAC 位址開啟電腦電源。

遠端存取

remoteaccess 模組提供對電腦的圖形遠端存取功能。 這些功能與可以從 Veyon Master 存取的功能相同。 例如,命令列工具提供的函數可用於建立直接存取特定電腦的程式捷徑。

control

這個命令開啟一個視窗,其具有可用於控制遠端電腦的遠端控制功能。 電腦名稱或 IP 位址 (以及選用的 TCP 埠) 必須作為參數傳遞:

veyon-cli remoteaccess control 192.168.1.2
view

這個命令開啟一個視窗,其具有遠端檢視功能以監視遠端電腦。 在此模式下,螢幕內容即時顯示,但在按一下工具列上的相應按鈕前,無法與電腦互動。 電腦或 IP 位址 (以及可選的 TCP 埠) 必須作為參數傳遞:

veyon-cli remoteaccess view pc5:5900

服務控制

service 模組可用於控制本機 Veyon 服務。

register

這個命令將 Veyon 服務註冊為作業系統中的服務,以便在電腦啟動時自動啟動該服務。

unregister

這個命令移除作業系統中的服務註冊,以便Veyon 服務不在開機時自動啟動。

start

這個命令啟動 Veyon 服務。

stop

這個命令停止 Veyon 服務。

restart

這個命令重新啟動 Veyon 服務。

status

這個命令查詢並顯示 Veyon 服務的狀態。

殼層

簡單殼層功能由 shell 模組提供。 如果呼叫這個模組而不含進一步參數,則啟用互動模式。 在此模式下,可以直接輸入所有 CLI 命令,而無需為每個命令指定和呼叫 veyon-cli 程式。 可以透過輸入關鍵字 exit 來離開模式。

此外,這個模組還可用於自動處理文字檔中的命令,以實現簡單的批次處理:

run <FILE>

這個命令逐行執行文字檔中指定的命令。 操作獨立於先前操作的結果執行,即錯誤不會導致終止。