Komut satırı arayüzü

Yönetimsel görevler için Veyon Configurator ve komut satırı aracı Veyon CLI kullanılabilir. Program komut satırında veyon-cli komutuyla başlatılabilir. Windows’ta, komut satırı penceresi açılır pencerelerini rahatsız etmeden görevleri otomatikleştirmeye izin veren ek bir konsol olmayan sürüm veyon-wcli vardır. $PATH (Linux) veya %PATH% (Windows) ortam değişkeni Veyon kurulum dizinini içermiyorsa, önce kurulum dizinine geçmeli veya dizini program adının önüne eklemelisiniz.

Program help parametresiyle çağrılırsa, tüm kullanılabilir modüllerin bir listesi görüntülenir. Liste, yüklü Veyon eklentilerine bağlı olarak değişebilir:

$ 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

Her CLI modülü help komutunu destekler, böylece her modül için tüm kullanılabilir komutların bir listesi görüntülenebilir. config modülü için örnek çıktı:

$ 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

Bazı modüller için help komutu, belirli bir komut için özel yardım almak amacıyla ek bir argüman olarak bir komut adıyla sağlanabilir:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Kimlik doğrulama anahtarı yönetimi

authkeys modülü, kimlik doğrulama anahtarlarının yönetilmesine olanak tanır; böylece kimlik doğrulama anahtarının içe aktarılması veya kullanıcı grubu ataması gibi yaygın işlemler kolayca otomatikleştirilebilir.

Not

<KEY> parametresi her zaman bir isim tanımlayıcısı ve bir türden oluşan bir anahtar ismine atıfta bulunur, örneğin teacher/public. Bir isim tanımlayıcısı yalnızca harflerden oluşmalıdır. Tür private veya public olmalıdır.

create <NAME>: Bu komut, adı <NAME> olan bir kimlik doğrulama anahtar çifti oluşturur ve özel ve genel anahtarı yapılandırılmış anahtar dizinlerine kaydeder. Parametre, yalnızca harflerden oluşabilen anahtar için bir ad olmalıdır.

delete <KEY>: Bu komut, <KEY> kimlik doğrulama anahtarını yapılandırılmış anahtar dizininden siler. Bir anahtar silindikten sonra kurtarılamayacağını lütfen unutmayın.

export <KEY> [<FILE>]: Bu komut <KEY> ila <FILE> kimlik doğrulama anahtarını dışa aktarır. <FILE> belirtilmezse, <KEY>’ün adı ve türünden bir ad oluşturulur.

extract <KEY>: Bu komut, özel anahtar <KEY>’den genel anahtar kısmını çıkarır ve ilişkili genel anahtar olarak kaydeder. Başka bir ana bilgisayar kurarken, yalnızca özel anahtarı aktarmak yeterlidir. Daha sonra genel anahtar çıkarılabilir.

import <KEY> [<FILE>]: Bu komut, <FILE> öğesinden <KEY> kimlik doğrulama anahtarını alır. <FILE> belirtilmezse, <KEY> adından ve türünden bir ad oluşturulur.

list [details]: Bu komut yapılandırılmış anahtar dizinindeki tüm kullanılabilir kimlik doğrulama anahtarlarını listeler. details seçeneği belirtilirse bunun yerine anahtar ayrıntılarının bulunduğu bir tablo görüntülenir. Bir anahtar erişilebilir değilse örneğin okuma izinlerinin olmaması nedeniyle bazı ayrıntılar eksik olabilir.

setaccessgroup <KEY> <ACCESS GROUP>: Bu komut, dosya erişim izinlerini <KEY>yalnızca kullanıcı grubunun<ACCESS GROUP> okuma erişimine sahip olmasını sağlayacak şekilde ayarlar.

Yapılandırma yönetimi

Yerel Veyon yapılandırması config modülü kullanılarak yönetilebilir. Hem tam yapılandırma hem de bireysel yapılandırma anahtarları okunabilir veya yazılabilir.

clear: Bu komut tüm yapılandırma anahtarlarını silerek tüm yerel yapılandırmayı sıfırlar. Bir yapılandırmayı içe aktarmadan önce eski ayarlar olmadan tanımlanmış bir durumu yeniden oluşturmak için bu komutu kullanın.

export

Bu komut yerel yapılandırmayı bir dosyaya aktarır. Hedef dosyanın adı ek bir parametre olarak belirtilmelidir:

veyon-cli config export myconfig.json

import

Bu komut daha önce dışa aktarılmış bir yapılandırma dosyasını yerel yapılandırmaya içe aktarır. İçe aktarılacak yapılandırma dosyasının adı ek bir argüman olarak belirtilmelidir:

veyon-cli config import myconfig.json

list [defaults | types]: Bu komut tüm yapılandırma anahtarlarının ve bunlara karşılık gelen değerlerin bir listesini gösterir. Bu şekilde, yapılandırma anahtarlarının adlarını, get veya set komutları aracılığıyla ayrı ayrı okumak veya yazmak için alabilirsiniz. Ek olarak defaults belirtildiğinde, gerçek yapılandırılmış değer yerine her yapılandırma anahtarı için varsayılan değer yazdırılır. Alternatif olarak, yapılandırma anahtarlarının veri türleri types belirtilerek incelenebilir.

get

Bu komut tek bir yapılandırma anahtarının okunmasına izin verir. Anahtarın adı bir parametre olarak sağlanmalıdır.

veyon-cli config get Network/VeyonServerPort

set

Bu komut tek bir yapılandırma anahtarı yazmak için kullanılabilir. Anahtarın adı ve istenen değer ek argümanlar olarak geçirilmelidir:

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

unset

Bu komutla tek bir yapılandırma anahtarı silinebilir, yani Veyon daha sonra dahili varsayılan değeri kullanır. Anahtarın adı ek bir argüman olarak geçirilmelidir:

veyon-cli config unset Directories/Screenshots

upgrade: Bu komutla Veyon ve tüm eklentilerin yapılandırması güncellenebilir ve kaydedilebilir. Bu, program veya eklenti güncellemeleri nedeniyle ayarlar veya yapılandırma biçimleri değişmişse gerekli olabilir.

Özellik denetimi

Feature modülü, uzak bilgisayarlarda mevcut özellikleri sorgulamak ve kontrol etmek için komutlar sağlar.

list: Mevcut tüm özelliklerin adlarını içeren bir liste görüntüler.

show: Mevcut tüm özellikler hakkında ayrıntılı bilgi içeren bir tablo görüntüler. Bu bilgiler bir açıklama, UID, ilgili özelliği sağlayan eklentinin adı ve diğer bazı uygulamayla ilgili ayrıntıları içerir.

start <FEATURE> <HOST ADRESS> [<ARGUMENTS>]: Belirtilen özelliği belirtilen ana bilgisayarda uzaktan çalışan Veyon Sunucusuna bağlanarak başlatır. Özellik, ad veya UID ile belirtilebilir. Tüm kullanılabilir özellikleri görmek için show komutunu kullanın. Özelliğe bağlı olarak, tek bir JSON dizesi olarak kodlanmış ek argümanlar (görüntülenecek metin mesajı gibi) belirtilmelidir. Daha fazla bilgi için lütfen geliştirici belgelerine bakın

stop <FEATURE> <HOST ADRESS>: Uzaktan çalışan Veyon Sunucusuna bağlanarak belirtilen ana bilgisayarda belirtilen özelliği durdurur. Özellik ad veya UID ile belirtilebilir. Kullanılabilir tüm özellikleri görmek için show komutunu kullanın.

LDAP

ldap modülünde kullanılabilen komutlar LDAP/AD entegrasyonu bölümündeki Komut satırı arayüzü bölümünde belgelenmiştir.

Ağ nesnesi dizini

Konumlar ve bilgisayarlar bölümünde açıklandığı gibi, Veyon, LDAP sunucusu mevcut olmadığında kullanılabilen yerleşik bir ağ nesnesi dizini sağlar. Bu ağ nesnesi dizini, Veyon Configurator’da ve komut satırında yönetilebilir. CSV içe aktarma gibi belirli işlemler şu anda yalnızca komut satırında kullanılabilir. Çoğu komut için, örneklerle birlikte ayrıntılı bir açıklama komuta özgü yardımda mevcuttur. Aşağıdaki komutlar networkobjects modülünde kullanılabilir:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Bu komut bir nesne ekler; burada <TYPE> konum veya bilgisayar olabilir. <PARENT> ise isim veya UUID olarak belirtilebilir.

clear: Bu komut tüm ağ nesnesi dizinini sıfırlar, yani tüm konumlar ve bilgisayarlar kaldırılır. Bu işlem özellikle otomatik içe aktarmadan önce faydalıdır.

dump: Bu komut, tam ağ nesnesi dizinini düz bir tablo olarak çıktı olarak verir. Nesne UID’si, türü veya adı gibi her özellik ayrı bir sütun olarak görüntülenir.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]: Bu komut, tam ağ nesnesi dizinini veya yalnızca belirtilen konumu bir metin dosyasına aktarmak için kullanılabilir. Biçimlendirme, yer tutucu değişkenleri içeren bir biçim dizesi aracılığıyla kontrol edilebilir. Bu, CSV dosyasının kolayca oluşturulmasını sağlar. Geçerli değişkenler %type%, %%name%, %host%, %mac% ve %location%’dir. Komut yardımında (veyon-cli networkobjects help export) çeşitli örnekler verilmiştir.

Not

Bu komutu toplu iş dosyalarında veya Windows’ta zamanlanmış görevler aracılığıyla kullanırken yüzde işaretini düzgün bir şekilde atladığınızdan emin olun, yani %type% yerine %%type%% kullanın. Aksi takdirde biçim dizelerinin bireysel parçaları ortam değişkenleri olarak ele alınacak ve çoğu durumda boş dizelerle değiştirilecektir. Bu, beklenmeyen ayrıştırma hatalarına yol açacaktır.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: Bu komut, bir metin dosyasını ağ nesnesi dizinine aktarmak için kullanılabilir. Giriş verilerinin işlenmesi, bir biçim dizesi veya yer tutucu değişkenler içeren bir düzenli ifade aracılığıyla kontrol edilebilir. Bu şekilde hem CSV dosyaları hem de diğer yapılandırılmış veri türleri içe aktarılabilir. Geçerli değişkenler %type%, %name%, %host%, %mac% ve %location%’dir. Komut yardımında (veyon-cli networkobjects help import) çeşitli örnekler verilmiştir.

Not

Bu komutu toplu iş dosyalarında veya Windows’ta zamanlanmış görevler aracılığıyla kullanırken yüzde işaretini düzgün bir şekilde atladığınızdan emin olun, yani %type% yerine %%type%% kullanın. Aksi takdirde biçim dizelerinin bireysel parçaları ortam değişkenleri olarak ele alınacak ve çoğu durumda boş dizelerle değiştirilecektir. Bu, beklenmeyen ayrıştırma hatalarına yol açacaktır.

list: Bu komut, tam ağ nesnesi dizinini biçimlendirilmiş bir liste olarak yazdırır. dump komutunun aksine, konumlar ve bilgisayarlar hiyerarşisi uygun biçimlendirmeyle temsil edilir.

remove <OBJECT>: Bu komut belirtilen nesneyi dizinden kaldırır. OBJECT, ad veya UUID ile belirtilebilir. Bir konumu kaldırmak, ilgili tüm bilgisayarları da kaldıracaktır.

Güç

Power modülü komut satırından güçle ilgili fonksiyonların kullanılmasına olanak tanır.

on <MAC ADDRESS>: Bu komut, verilen MAC adresine sahip bilgisayarı ağ üzerinden uyandırmak için Ağdan-Uyandırma (WOL) paketi yayımlar

Uzaktan erişim

remoteaccess modülü, bilgisayarlara grafiksel uzaktan erişim için işlevler sağlar. Bunlar, Veyon Master’dan erişilebilen işlevlerle aynıdır. Komut satırı aracının sağladığı işlev, örneğin belirli bir bilgisayara doğrudan erişim için bir program kısayolu oluşturmak için kullanılabilir.

control

Bu komut, uzak bir bilgisayarı kontrol etmek için kullanılabilen uzaktan kontrol işlevine sahip bir pencere açar. Bilgisayar adı veya IP adresi (ve isteğe bağlı olarak TCP portu) bir argüman olarak geçirilmelidir:

veyon-cli remoteaccess control 192.168.1.2

view

Bu komut, uzak bir bilgisayarı izlemek için uzaktan görüntüleme işlevine sahip bir pencere açar. Bu modda ekran içeriği gerçek zamanlı olarak görüntülenir, ancak araç çubuğundaki ilgili düğmeye tıklanana kadar bilgisayarla etkileşim mümkün değildir. Bilgisayar veya IP adresi (ve isteğe bağlı olarak TCP portu) bir argüman olarak geçirilmelidir:

veyon-cli remoteaccess view pc5:5900

Hizmet kontrolü

Service modülü yerel Veyon Servisini kontrol etmek için kullanılabilir.

register: Bu komut, Veyon Servisini işletim sisteminde bir servis olarak kaydeder, böylece bilgisayar başlatıldığında otomatik olarak başlatılır.

unregister: Bu komut işletim sistemindeki servis kaydını kaldırır, böylece Veyon Servisi artık önyükleme sırasında otomatik olarak başlatılmaz.

start: Bu komut Veyon Servisini başlatır.

stop: Bu komut Veyon Servisini durdurur.

restart: Bu komut Veyon Servisini yeniden başlatır.

status: Bu komut Veyon Servisinin durumunu sorgular ve görüntüler.

Kabuk

Basit kabuk işlevleri shell modülü tarafından sağlanır. Bu modül başka argümanlar olmadan çağrılırsa, etkileşimli bir mod başlatılır. Bu modda, tüm CLI komutları her komut için veyon-cli programını belirtmeye ve çağırmaya gerek kalmadan doğrudan girilebilir. Moddan exit anahtar sözcüğü girilerek çıkılabilir.

Ayrıca modül, basit toplu işlemleri uygulamak amacıyla bir metin dosyasındaki komutların otomatik olarak işlenmesi için de kullanılabilir:

run <FILE>: Bu komut, metin dosyasında belirtilen komutları satır satır yürütür. İşlemler, önceki işlemlerin sonucundan bağımsız olarak yürütülür, yani bir hata sonlandırmaya yol açmaz.