Utilitzar el programa de l’agent de Cyberwatch manualment

Aquesta pàgina de documentació presenta les diferents ordres i subordres que ofereix el programa de l’agent de Cyberwatch.

Un cop instal·lat en un actiu Windows o Linux, el programa cyberwatch-agent es pot executar com qualsevol altre programa o executable.

L’ús manual de l’agent de Cyberwatch des de la línia d’ordres pot servir per respondre a alguns casos d’ús específics. En funcionament normal, l’agent no requereix cap intervenció als actius un cop instal·lat i ha de funcionar de manera autònoma d’acord amb les especificitats del sistema en què està instal·lat.

Alguns casos d’ús possibles del programa des de la línia d’ordres són, per exemple:

• la reconfiguració de l’URL d’un agent ja instal·lat en un actiu (cas pràctic il·lustrat més avall)
• el nou registre d’un agent ja instal·lat en una mateixa instància de Cyberwatch
• qualsevol tasca de depuració avançada que pugui ajudar a diagnosticar un problema de funcionament de l’agent o de comunicació amb la interfície de Cyberwatch

Descripció de les subordres i opcions del programa cyberwatch-agent

El programa ofereix diverses subordres i opcions que permeten modificar la configuració de l’agent o executar determinades accions.

L’opció -h o --help de l’ordre cyberwatch-agent descriu exhaustivament aquests elements:

En la data de redacció d’aquesta documentació, aquest és el resultat de l’execució d’aquesta ordre:

$ 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

La subordre check permet verificar l’estat de la configuració de l’agent instal·lat a l’actiu.

Aquesta ordre proporciona informació sobre:

• l’entorn (sistema, codificació…)
• l’estat de la instal·lació
• l’estat de la configuració
• el funcionament dels registres
• la connectivitat amb Cyberwatch
• els drets concedits a l’agent

register

La subordre register registra l’agent a la instància de Cyberwatch.

És l’ordre que s’executa per defecte durant la instal·lació de l’agent als actius.

Si l’agent ja està registrat, l’ordre no té cap efecte.

get_tasks

La subordre get_tasks consulta la instància de Cyberwatch per obtenir la llista de tasques que cal executar a l’actiu.

La instància de Cyberwatch ordena aquestes tasques, que poden incloure, entre d’altres:

• iniciar un escaneig
• desplegar un pedaç
• reiniciar l’actiu

set_config

La subordre set_config modifica la configuració de l’agent instal·lat actualment a partir de les opcions que ofereix l’agent.

Permet, per exemple, reconfigurar els agents en cas que canviï l’URL de la instància de Cyberwatch.

Modificar l’URL de configuració dels agents després d’un canvi d’URL de la instància de Cyberwatch

Si l’URL d’accés a la instància de Cyberwatch canvia, els agents ja no poden comunicar-se amb la instància de Cyberwatch. Per restablir la connexió, cal modificar l’URL de l’API configurada al fitxer de configuració de cadascun dels agents. Aquesta secció descriu com fer-ho.

També cal modificar l’URL configurada al programari des del menú Administració > Nodes. Aquesta URL és l’adreça que els agents utilitzen per defecte quan es creen des de la interfície de Cyberwatch. Cyberwatch recomana utilitzar un àlies DNS per evitar els problemes derivats d’un possible canvi de l’adreça IP del servidor de Cyberwatch, que es tracten en aquest cas pràctic.

Si cal reconfigurar l’URL de l’API dels agents, aquesta operació es pot fer amb l’ordre següent.

A Windows (PowerShell):

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

A Linux:

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

on [NOUVEL_URL] s’ha de substituir per la nova URL de la instància de Cyberwatch.