Usar el programa del agente Cyberwatch manualmente

Esta página de documentación presenta los diferentes comandos y subcomandos propuestos por el programa del agente Cyberwatch.

Una vez instalado en un activo Windows o Linux, el programa cyberwatch-agent puede ejecutarse como cualquier otro programa o ejecutable.

El uso manual del agente Cyberwatch desde la línea de comandos puede permitir responder a ciertos casos de uso específicos. En funcionamiento normal, el agente no requiere intervención en los activos una vez instalado y debe funcionar de forma autónoma según las características del sistema en el que está instalado.

Los casos de uso potenciales del programa en línea de comandos son, por ejemplo:

• la reconfiguración de la URL de un agente ya instalado en un activo (caso práctico ilustrado a continuación)
• el re-registro de un agente ya instalado en una misma instancia Cyberwatch
• cualquier tarea de depuración avanzada que ayude a diagnosticar un problema de funcionamiento del agente o de comunicación con la interfaz Cyberwatch

Descripción de subcomandos y opciones del programa cyberwatch-agent

El programa ofrece diferentes subcomandos y opciones que permiten modificar la configuración del agente o ejecutar ciertas acciones.

Estos elementos se describen exhaustivamente usando la opción -h o --help del comando cyberwatch-agent:

A la fecha de redacción de esta documentación, este es el resultado de la ejecución de este comando:

$ cyberwatch-agent -h
usage: cyberwatch-agent [-h] [-V] [-q] [-d] [--api-url URL] [--access-key-id KEY] [--secret-access-key KEY] [--category CATEGORY] [--later]
                        [--allow_selfsigned bool] [--proxy_enabled bool] [--proxy_host URL] [--groups GROUPS]
                        [{check,register,get_tasks,set_config}]

positional arguments:
  {check,register,get_tasks,set_config}

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -q, --quiet           quiet output: print only errors
  -d, --debug           debug output
  --api-url URL         set api base url when registering
  --access-key-id KEY   set api access key id when registering
  --secret-access-key KEY
                        set api secret access key when registering
  --category CATEGORY   set the category of the computer when registering
  --later               Register only the next time the agent starts
  --allow_selfsigned bool
                        allow selfsigned certificates from the Cyberwatch server (default false)
  --proxy_enabled bool  enable proxy for Cyberwatch API requests (default false)
  --proxy_host URL      set the proxy for Cyberwatch API requests (https://username:password@host:port/ format)
  --groups GROUPS       set the server's groups by separating each one with a coma

check

El subcomando check permite verificar el estado de la configuración del agente instalado en el activo.

Este comando permite obtener información sobre:

• el entorno (sistema, codificación…)
• el estado de la instalación
• el estado de la configuración
• el funcionamiento de los logs
• la conectividad con Cyberwatch
• los permisos otorgados al agente

register

El subcomando register registra el agente en la instancia Cyberwatch.

Es el comando ejecutado por defecto durante la instalación del agente en los activos.

Si el agente ya está registrado, el comando no tendrá efecto.

get_tasks

El subcomando get_tasks consulta la instancia Cyberwatch para obtener la lista de tareas a ejecutar en el activo.

Estas tareas son ordenadas por la instancia Cyberwatch y pueden incluir, en particular:

• lanzar un escaneo
• desplegar un parche
• reiniciar el activo

set_config

El subcomando set_config modifica la configuración del agente actualmente instalado a partir de las opciones propuestas por el agente.

Permite, por ejemplo, reconfigurar los agentes en caso de un cambio

de URL de la instancia Cyberwatch.

Modificar la URL de configuración de los agentes tras un cambio de URL de la instancia Cyberwatch

Si la URL de acceso a la instancia Cyberwatch cambia, los agentes ya no podrán comunicarse con la instancia Cyberwatch. Para restablecer la conexión, hay que modificar la URL de la API configurada en el archivo de configuración de cada agente. Esta sección describe cómo proceder.

También es necesario modificar la URL configurada en el software desde el menú Administración > Nodos. Esta URL representa la dirección utilizada por defecto por los agentes durante su creación desde la interfaz Cyberwatch. Cyberwatch recomienda el uso de un alias DNS para evitar los problemas relacionados con un posible cambio de la dirección IP del servidor Cyberwatch tratados en este caso práctico.

En caso de que sea necesario reconfigurar la URL de la API de los agentes, esta operación se puede realizar con el siguiente comando.

En Windows (PowerShell):

& 'C:\Program Files\CYBERWATCH SAS\CyberwatchAgent\cyberwatch-agent.exe' set_config --api-url 'https://[NUEVA_URL]/api/v2/'

En Linux:

sudo cyberwatch-agent set_config --api-url 'https://[NUEVA_URL]/api/v2/'

donde [NUEVA_URL] debe reemplazarse por la nueva URL de la instancia Cyberwatch.