Interfaz de línea de comandos

Para tareas administrativas, Veyon Configurator y la herramienta de línea de comando Veyon CLI están disponibles. El programa se puede iniciar mediante el comando veyon-cli en la línea de comandos. En Windows, hay una versión adicional que no es de consola, veyon-wcli, que permite automatizar tareas sin molestas ventanas emergentes de línea de comandos. Si la variable de entorno $PATH (Linux) o %PATH% (Windows) no contiene el directorio de instalación de Veyon, primero debe cambiar al directorio de instalación o anteponer el directorio al nombre del programa .

Si se llama al programa con el parámetro help, se muestra una lista de todos los módulos disponibles. La lista puede variar dependiendo de los complementos Veyon instalados:

$ 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

Cada módulo CLI admite el comando help, de modo que se puede mostrar una lista de todos los comandos disponibles para cada módulo. Salida de muestra para el módulo 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

Para algunos módulos, el comando help se puede suministrar con un nombre de comando como argumento adicional para obtener ayuda específica para un comando:

$ veyon-cli remoteaccess help control

remoteaccess control <host>

Gestión de claves de autenticación

El módulo authkeys permite la gestión de claves de autenticación para que operaciones comunes como la importación de una clave de autenticación o la asignación de un grupo de usuarios puedan automatizarse fácilmente.

Nota

El parámetro <KEY> siempre se refiere a un nombre de clave que consiste en un identificador de nombre y un tipo, por ejemplo teacher/public. Un identificador de nombre debe constar de letras solamente. El tipo debe ser private o public.

create <NAME>

Este comando crea un par de claves de autenticación con nombre <NAME> y guarda la clave privada y pública en los directorios de claves configuradas. El parámetro debe ser un nombre para la clave, que solo puede contener letras.

delete <KEY>

Este comando elimina la clave de autenticación <KEY> del directorio de claves configuradas. Tenga en cuenta que una clave no se puede recuperar una vez que se ha eliminado.

export <KEY> [<FILE>]

Este comando exporta la clave de autenticación de <KEY> a <FILE>. Si <FILE> no especifica un nombre, se construirá un nombre a partir del nombre y tipo de <KEY>.

extract <KEY>

Este comando extrae la parte de la clave pública de la clave privada <KEY> y la guarda como la clave pública asociada. Por lo tanto, cuando se configura otro equipo maestro, es suficiente con transferir solo la clave privada. La clave pública puede ser extraída.

import <KEY> [<FILE>]

Este comando importa la clave de autenticación <KEY> desde <FILE>. Si no se especifica <FILE>, se construirá un nombre a partir del nombre y tipo de <KEY>.

list [details]

Este comando lista todas las claves de autenticación disponibles en el directorio de claves configurado. Si se especifica la opción details se mostrará una tabla con los detalles de las claves. Es posible que falten algunos detalles si una clave no es accesible, por ejemplo, debido a la falta de permisos de lectura.

setaccessgroup <KEY> <ACCESS GROUP>

Este comando ajusta los permisos de acceso a los archivos a <KEY> para que solo el grupo de usuarios <ACCESS GROUP> tenga acceso de lectura.

Gestión de la configuración

La configuración local de Veyon se puede administrar usando el módulo config. Tanto la configuración completa como las claves de configuración individuales se pueden leer o escribir.

clear

Este comando restablece toda la configuración local al eliminar todas las claves de configuración. Use este comando para recrear un estado definido sin configuraciones antiguas antes de importar una configuración.

export

Este comando exporta la configuración local a un archivo. El nombre del archivo de destino debe especificarse como un parámetro adicional:

veyon-cli config export myconfig.json
import

Este comando importa un archivo de configuración previamente exportado a la configuración local. El nombre del archivo de configuración a importar debe especificarse como un argumento adicional:

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

Este comando muestra una lista de todas las claves de configuración y sus valores correspondientes. De esta forma, puede obtener los nombres de las claves de configuración para leerlas o escribirlas individualmente a través de los comandos get o set. Al especificar adicionalmente defaults, se imprime el valor predeterminado para cada clave de configuración en lugar del valor configurado real. Alternativamente, los tipos de datos de las claves de configuración se pueden inspeccionar especificando types.

get

Este comando permite leer una sola clave de configuración. El nombre de la clave debe ser suministrado como un parámetro.

veyon-cli config get Network/VeyonServerPort
set

Este comando se puede utilizar para escribir una sola clave de configuración. El nombre de la clave y el valor deseado se deben pasar como argumentos adicionales:

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

Con este comando se puede eliminar una sola clave de configuración, es decir, Veyon usará el valor predeterminado interno. El nombre de la clave se debe pasar como un argumento adicional:

veyon-cli config unset Directories/Screenshots
upgrade

Con este comando, la configuración de Veyon y todos los complementos se pueden actualizar y guardar. Esto puede ser necesario si las configuraciones o los formatos de configuración han cambiado debido a las actualizaciones del programa o complemento.

Control de funciones

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

Los comandos disponibles en el módulo ldap están documentados en la sección Interfaz de línea de comandos en el capítulo Integración LDAP/AD.

Directorio de objetos de red

Como se describe en la sección Ubicaciones y equipos, Veyon proporciona un directorio de objetos de red integrado que se puede usar cuando no hay un servidor LDAP disponible. Este directorio de objetos de red se puede administrar en Veyon Configurator, así como en la línea de comandos. Algunas operaciones, como la importación de CSV, actualmente solo están disponibles en la línea de comandos. Para la mayoría de los comandos, hay disponible una descripción detallada con ejemplos en la ayuda específica del comando. Los siguientes comandos se pueden usar en el módulo networkobjects:

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

Este comando agrega un objeto, donde <TYPE> puede ser location o computer. <PARENT> se puede especificar como nombre o UUID.

clear

Este comando restablece todo el directorio de objetos de red, es decir, se eliminan todas las ubicaciones y computadoras. Esta operación es particularmente útil antes de cualquier importación automatizada.

dump

Este comando genera el directorio completo de objetos de red como una tabla plana. Cada propiedad, como el UID de objeto, tipo o nombre, se muestra como una columna separada.

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

Este comando se puede utilizar para exportar el directorio de objetos de red completo o solo la ubicación especificada a un archivo de texto. El formato se puede controlar mediante una cadena de formato que contiene variables de marcador de posición. Esto permite generar archivos CSV fácilmente. Las variables válidas son %type%, %name%, %host%, %mac% y %location%. Se dan varios ejemplos en la ayuda de comandos (veyon-cli networkobjects help export).

Nota

Cuando use este comando en archivos por lotes o mediante tareas programadas en Windows, asegúrese de escapar correctamente del signo de porcentaje, es decir, use %%type%% en lugar de %type%. De lo contrario, las partes individuales de las cadenas de formato se tratarán como variables de entorno y se sustituirán por cadenas vacías en la mayoría de los casos. Esto conducirá a errores de análisis inesperados.

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

Este comando se puede usar para importar un archivo de texto al directorio de objetos de la red. El procesamiento de los datos de entrada se puede controlar mediante una cadena de formato o una expresión regular con variables dentro. De esta manera se pueden importar archivos CSV y otros tipos de datos estructurados. Las variables válidas son %type%, %name%, %host%, %mac% y %location%. Se dan varios ejemplos en el comando help (veyon-cli networkobjects help import).

Nota

Cuando use este comando en archivos por lotes o mediante tareas programadas en Windows, asegúrese de escapar correctamente del signo de porcentaje, es decir, use %%type%% en lugar de %type%. De lo contrario, las partes individuales de las cadenas de formato se tratarán como variables de entorno y se sustituirán por cadenas vacías en la mayoría de los casos. Esto conducirá a errores de análisis inesperados.

list

Este comando imprime el directorio completo de objetos de red como una lista formateada. A diferencia del comando dump, la jerarquía de ubicaciones y computadoras está representada por un formato apropiado.

remove <OBJECT>

Este comando elimina el objeto especificado del directorio. OBJECT se puede especificar por nombre o UUID. Eliminar una ubicación también eliminará todas las computadoras relacionadas.

Power

El módulo de energía permite utilizar funciones relacionadas con la energía desde la línea de comandos.

on <MAC ADDRESS>

Este comando transmite un paquete Wake-on-LAN (WOL) a la red para encender el equipo con la dirección MAC proporcionada.

Acceso remoto

El módulo remoteaccess proporciona funciones para un acceso gráfico remoto a las computadoras. Estas son las mismas funciones a las que se puede acceder desde Veyon Master. La función proporcionada por la herramienta de línea de comandos se puede usar, por ejemplo, para crear un acceso directo del programa para el acceso directo a una computadora específica.

control

Este comando abre una ventana con la función de control remoto que se puede usar para controlar una computadora remota. El nombre del equipo o la dirección IP (y, opcionalmente, el puerto TCP) se deben pasar como argumento:

veyon-cli remoteaccess control 192.168.1.2
view

Este comando abre una ventana con la función de vista remota para monitorizar una computadora remota. En este modo, el contenido de la pantalla se muestra en tiempo real, pero la interacción con la computadora no es posible hasta que se hace clic en el botón correspondiente en la barra de herramientas. La computadora o la dirección IP (y opcionalmente el puerto TCP) deben pasarse como argumento:

veyon-cli remoteaccess view pc5:5900

Control de servicio

El módulo service se puede usar para controlar el Veyon Service local.

register

Este comando registra Veyon Service como un servicio en el sistema operativo para que se inicie automáticamente cuando se inicia la computadora.

unregister

Este comando elimina el registro del servicio en el sistema operativo para que Veyon Service ya no se inicie automáticamente en el momento del arranque.

start

Este comando inicia Veyon Service.

stop

Este comando detiene Veyon Service.

restart

Este comando reinicia Veyon Service.

status

Este comando consulta y muestra el estado de Veyon Service.

Shell

El módulo shell proporciona funcionalidades de shell simples. Si se llama a este módulo sin más argumentos, se inicia un modo interactivo. En este modo, todos los comandos de CLI se pueden ingresar directamente sin tener que especificar y llamar al programa veyon-cli para cada comando. El modo se puede dejar ingresando la palabra clave exit.

Además, el módulo se puede utilizar para el procesamiento automatizado de comandos en un archivo de texto con el fin de implementar un procesamiento por lotes simple:

run <FILE>

Este comando ejecuta los comandos especificados en el archivo de texto línea por línea. Las operaciones se ejecutan independientemente del resultado de las operaciones anteriores, es decir, un error no conduce a la terminación.