Інтерфейс командного рядка¶

Для виконання завдань з адміністрування можна скористатися Засобом налаштовування 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

Для кожного модуля інтерфейсу командного рядка передбачено команду 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. Ідентифікатор назви має складатися лише з літер. Типом може бути рядок private (закритий ключ) або public (відкритий ключ).

create <NAME>: Ця команда створює нову пару ключів для розпізнавання із назвою <НАЗВА> і зберігає закритий і відкритий ключі до налаштованих каталогів ключів. Параметром має бути назва ключа, яка має складатися лише з літер.

delete <KEY>: Ця команда вилучає ключ розпізнавання <КЛЮЧ> із налаштованого каталогу ключів. Будь ласка, зауважте, що після вилучення ключ не можна буде відновити.

export <KEY> [<FILE>]: Ця команда експортує ключ розпізнавання <КЛЮЧ> до файла <ФАЙЛ>. Якщо файл <ФАЙЛ> не вказано, його назву буде побудовано на основі даних щодо назви і типу ключа <КЛЮЧ>

extract <KEY>: Ця команда видобуває частину, пов’язану із відкритим ключем, з закритого ключа <КЛЮЧ> і зберігає її до відповідного файла відкритого ключа. Через це при налаштовуванні додаткового основного комп’ютера достатньо перенести на нього лише закритий ключ. Після перенесення відкритий ключ можна просто видобути.

import <KEY> [<FILE>]: Ця команда імпортує ключ розпізнавання <КЛЮЧ> з файла <ФАЙЛ> Якщо файл <ФАЙЛ> не вказано, його назву буде побудовано на основі даних щодо назви і типу ключа <КЛЮЧ>.

list [details]: Ця команда виводить список усіх доступних ключів розпізнавання у налаштованому каталозі ключів. Якщо вказано параметр details, замість списку буде виведено таблицю із подробицями щодо ключів. Деякі параметри ключа може бути не показано, якщо доступ до ключа обмежено, наприклад через брак прав на читання файла ключа.

setaccessgroup <KEY> <ACCESS GROUP>: Ця команда коригує права доступу до файла <КЛЮЧ> так, що право на читання цього файла отримують лише учасники групи <ГРУПА ДОСТУПУ>.

Керування налаштуваннями¶

Керувати локальними налаштуваннями Veyon можна за допомогою модуля config. Передбачено можливість читання і запису усіх налаштувань та окремих ключів налаштувань.

clear: Ця команда скидає усі локальні налаштування вилученням ключів налаштувань. Скористайтеся нею для відновлення типового стану без застарілих налаштувань до імпортування налаштувань.

export

У результаті виконання цієї команди усі локальні налаштування буде експортовано до файла. Назву файла призначення має бути вказано як додатковий параметр:

veyon-cli config export myconfig.json

import

Ця команда імпортує попередньо експортований файл налаштувань до локальних налаштувань. Назву файла налаштувань, які слід імпортувати, має бути вказано як додатковий аргумент:

veyon-cli config import myconfig.json

list [defaults | types]: Ця команда показує список усіх ключів налаштування та відповідних значень. За її допомогою ви можете отримати список назв ключів налаштування з метою читання та запису окремих ключів за допомогою команд get та set. Якщо додатково вказано defaults, для кожного ключа налаштувань буде виведено типове значення, замість поточного налаштованого значення. Крім того, можна ознайомитися із типами даних ключів налаштування, додавши types.

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 і усіх додатків. Це може бути необхідним, якщо формати параметрів або налаштувань змінено через оновлення програм або додатків.

Керування можливосями¶

Модуль feature забезпечує роботу команд опитування щодо доступних можливостей і керування ними на віддалених комп’ютерах.

list: Показати список із назвами усіх доступних можливостей

show: Показує таблицю із докладними відомостями щодо усіх доступних можливостей. Серед цих відомостей опис, UID, назва додатка, який забезпечує роботу можливості, та деякі інші пов’язані із реалізацією подробиці.

start <FEATURE> <HOST ADRESS> [<ARGUMENTS>]: Запускає вказану можливість на вказаному вузлі шляхом з’єднання із запущеним віддалено сервером Veyon. Можливість можна вказати за назвою або UID. Скористайтеся командою «show», щоб переглянути список усіх доступних можливостей. Залежно від можливості, може бути вказано додаткові аргументи (зокрема текстове повідомлення для показу), які має бути закодовано у один рядок JSON. Щоб дізнатися більше, зверніться до документації для розробників.

stop <FEATURE> <HOST ADRESS>: Зупиняє роботу вказаної можливості на вказанмоу вузлі шляхом з’єднання із запущеним віддалено сервером Veyon. Можливість можна вказати за назвою або UID. Скористайтеся командою «show», щоб переглянути список усіх доступних можливостей.

LDAP¶

Команди модуля ldap описано у розділі Інтерфейс командного рядка глави Інтеграція з LDAP/AD.

Каталог мережевих об’єктів¶

Як описано у розділі Місця і комп’ютери, у Veyon передбачено вбудований каталог об’єктів мережі, яким можна скористатися, якщо немає доступного сервера LDAP. Керувати цим каталогом мережевих об’єктів можна за допомогою засобу налаштовування Veyon, а також за допомогою командного рядка. Деякі з дій, зокрема імпортування даних у форматі CSV, у поточній версії доступні лише з командного рядка. Для більшості команд із докладним описом із прикладами можна ознайомитися у довідці з команди. У модулі networkobjects можна скористатися такими командами:

add <TYPE> <NAME> [<HOST ADDRESS> <MAC ADDRESS> <PARENT>]: Ця команда додає об’єкт, де значенням <TYPE> може бути location або computer. <PARENT> може бути задано у форматі назви або UUID.

clear: За допомогою цієї команди можна відновити початковий стан каталогу об’єктів мережі, тобто вилучити усі записи місць і комп’ютерів. Така дія може знадобитися перед автоматичним імпортуванням даних.

dump: Ця команда виводить увесь каталог об’єктів мережі у форматі простої таблиці. Кожна властивість, зокрема UID об’єкта, тип або назву буде показано у окремому стовпчику.

export <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>]: Цією командою можна скористатися для експортування даних або усього каталогу об’єктів мережі, або лише вказаного місця до текстового файла. Форматуванням можна керувати за допомогою рядка форматування зі змінними у ньому. Таким чином можна без проблем створити файл CSV. Коректними змінними є %type% (тип), %name% (назва), %host% (вузол), %mac% (MAC-адреса) та %location% (місце). Різноманітні приклади наведено у довідці з команди (veyon-cli networkobjects help export).

Примітка

Якщо користуватиметеся цією командою у пакетних файлах або у записах запланованих завдань у Windows, вам слід належним чином екранувати символ відсотків, тобто використовувати %%тип%% замість %тип%. Якщо ви цього не зробите, окремі частини рядків форматування будуть вважатися змінними середовища і, у більшості випадків, замінюватимуться порожніми рядками. Це призведе до неочікуваних помилок під час обробки.

import <FILE> [location <LOCATION>] [format <FORMAT-STRING-WITH-VARIABLES>] [regex <REGULAR-EXPRESSION-WITH-VARIABLES>]: За допомогою цієї команди можна імпортувати текстовий файл до каталогу об’єктів мережі. Обробкою вхідних даних можна керувати за допомогою рядка форматування або формального виразу із використанням змінних. У такий спосіб можна імпортувати і файли CSV, і файли інших структурованих даних. Коректними змінними є %type% (тип), %name% (назва), %host% (вузол), %mac% (MAC-адреса) та %location% (клас). Різноманітні приклади наведено у довідці з команди (veyon-cli networkobjects help import).

Примітка

Якщо користуватиметеся цією командою у пакетних файлах або у записах запланованих завдань у Windows, вам слід належним чином екранувати символ відсотків, тобто використовувати %%тип%% замість %тип%. Якщо ви цього не зробите, окремі частини рядків форматування будуть вважатися змінними середовища і, у більшості випадків, замінюватимуться порожніми рядками. Це призведе до неочікуваних помилок під час обробки.

list: Ця команда виводить вміст усього каталогу об’єктів мережі у вигляді форматованого списку. На відміну від команди dump, ієрархія місць і комп’ютерів відтворюється відповідним форматуванням.

remove <OBJECT>: Ця команда вилучає вказаний об’єкт з каталогу. 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. Якщо цей модуль викликати без аргументів, його буде запущено у інтерактивному режимі. У цьому режимі усі команди інтерфейсу командного рядка можна буде вводити безпосередньо без зазначення та виклику програми veyon-cli у кожній команді. Вийти з цього режиму можна введенням ключового слова exit.

Крім того, модулем можна скористатися для автоматичної обробки команд у текстовому файлі з метою реалізувати просту пакетну обробку:

run <FILE>: Ця команда виконує команди, які вказано у текстовому файлі, рядок за рядком. Команди виконуватимуться незалежно від результату попередніх команд, тобто помилки не призводитимуть до переривання послідовності команд.