Utilizzare manualmente il programma dell’agent Cyberwatch

Questa pagina della documentazione presenta i diversi comandi e sottocomandi offerti dal programma dell’agent Cyberwatch.

Una volta installato su un asset Windows o Linux, il programma cyberwatch-agent può essere eseguito come qualsiasi altro programma o eseguibile.

L’utilizzo manuale dell’agent Cyberwatch dalla riga di comando può consentire di rispondere ad alcuni casi d’uso specifici. In condizioni di funzionamento normali, l’agent non richiede interventi sugli asset una volta installato e deve funzionare in modo autonomo in conformità con le specificità del sistema su cui è installato.

I potenziali casi d’uso del programma da riga di comando sono ad esempio:

  • la riconfigurazione dell’URL di un agent già installato su un asset (caso pratico illustrato di seguito)
  • la nuova registrazione di un agent già installato su una stessa istanza Cyberwatch
  • qualsiasi attività di debug avanzato che possa aiutare a diagnosticare un problema di funzionamento dell’agent o di comunicazione con l’interfaccia Cyberwatch

Descrizione dei sottocomandi e delle opzioni del programma cyberwatch-agent

Il programma offre diversi sottocomandi e opzioni che consentono di modificare la configurazione dell’agent o di eseguire determinate azioni.

Questi elementi sono descritti in modo esaustivo tramite l’opzione -h o --help del comando cyberwatch-agent:

Alla data di redazione di questa documentazione, il risultato dell’esecuzione di questo comando è il seguente:

$ 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

Il sottocomando check consente di verificare lo stato della configurazione dell’agent installato sull’asset.

Questo comando consente di ottenere informazioni su:

  • l’ambiente (sistema, codifica…)
  • lo stato dell’installazione
  • lo stato della configurazione
  • il funzionamento dei log
  • la connettività a Cyberwatch
  • i diritti concessi all’agent

register

Il sottocomando register registra l’agent presso l’istanza Cyberwatch.

È il comando eseguito per impostazione predefinita durante l’installazione dell’agent sugli asset.

Se l’agent è già registrato, il comando non avrà alcun effetto.

get_tasks

Il sottocomando get_tasks interroga l’istanza Cyberwatch per ottenere l’elenco dei job da eseguire sull’asset.

Questi job sono ordinati dall’istanza Cyberwatch e possono includere in particolare:

  • avviare una scansione
  • distribuire una patch
  • riavviare l’asset

set_config

Il sottocomando set_config modifica la configurazione dell’agent attualmente installato in base alle opzioni offerte dall’agent.

Consente ad esempio di riconfigurare gli agent in caso di modifica dell’URL dell’istanza Cyberwatch.

Modificare l’URL di configurazione degli agent in seguito a una modifica dell’URL dell’istanza Cyberwatch

Se l’URL di accesso all’istanza Cyberwatch cambia, gli agent non saranno più in grado di comunicare con l’istanza Cyberwatch. Per ripristinare la connessione, è necessario modificare l’URL dell’API configurato nel file di configurazione di ciascun agent. Questa sezione descrive come procedere.

È inoltre necessario modificare l’URL configurato nel software dal menu Amministrazione > Nodi. Questo URL rappresenta l’indirizzo utilizzato per impostazione predefinita dagli agent al momento della loro creazione dall’interfaccia Cyberwatch. Cyberwatch consiglia l’utilizzo di un alias DNS per evitare i problemi legati a una potenziale modifica dell’indirizzo IP del server Cyberwatch trattati in questo caso pratico.

Nel caso in cui sia necessaria una riconfigurazione dell’URL dell’API degli agent, questa operazione può essere eseguita tramite il comando seguente.

Su Windows (PowerShell):

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

Su Linux:

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

dove [NOUVEL_URL] deve essere sostituito con il nuovo URL dell’istanza Cyberwatch.