Risoluzione dei problemi utilizzando la console seriale


Questa pagina descrive come attivare l'accesso interattivo alla console seriale di un'istanza per eseguire il debug dei problemi di avvio e di rete, risolvere i problemi di funzionamento delle istanze, interagire con il GRand Unified Bootloader (GRUB) ed eseguire altre attività di risoluzione dei problemi.

Un'istanza di una macchina virtuale (VM) ha quattro porte seriali virtuali. L'interazione con una porta seriale è simile all'utilizzo di una finestra di terminale, in quanto l'input e l'output sono interamente in modalità di testo e non è presente un'interfaccia grafica o il supporto del mouse. Il sistema operativo, il BIOS e altre entità a livello di sistema dell'istanza spesso scrivono l'output nelle porte seriali e possono accettare input come comandi o risposte ai prompt. In genere, queste entità a livello di sistema utilizzano la prima porta seriale (porta 1), che viene spesso indicata come console seriale.

Se devi solo visualizzare l'output della porta seriale senza emettere comandi alla console seriale, puoi chiamare il metodo getSerialPortOutput o utilizzare Cloud Logging per leggere le informazioni scritte dall'istanza nella porta seriale. Consulta Visualizzazione dei log della porta seriale. Tuttavia, se riscontri problemi di accesso all'istanza tramite SSH o devi risolvere i problemi di un'istanza che non è completamente avviata, puoi attivare l'accesso interattivo alla console seriale, che ti consente di connetterti e interagire con qualsiasi porta seriale dell'istanza. Ad esempio, puoi eseguire direttamente i comandi e rispondere ai prompt nella porta seriale.

Quando attivi o disattivi la porta seriale, puoi utilizzare qualsiasi valore booleano accettato dal server dei metadati. Per ulteriori informazioni, consulta Valori booleani.

Prima di iniziare

  • Se non l'hai ancora fatto, configura l'autenticazione. L'autenticazione è la procedura mediante la quale la tua identità viene verificata per l'accesso alle API e ai servizi Google Cloud. Per eseguire codice o esempi da un ambiente di sviluppo locale, puoi autenticarti su Compute Engine selezionando una delle seguenti opzioni:

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. Install the Google Cloud CLI, then initialize it by running the following command:

      gcloud init
    2. Set a default region and zone.
    3. REST

      Per utilizzare gli esempi dell'API REST in questa pagina in un ambiente di sviluppo locale, utilizza le credenziali fornite a gcloud CLI.

        Install the Google Cloud CLI, then initialize it by running the following command:

        gcloud init

      Per ulteriori informazioni, consulta Eseguire l'autenticazione per l'utilizzo di REST nella documentazione sull'autenticazione di Google Cloud.

Attivazione dell'accesso interattivo sulla console seriale

Abilita l'accesso alla console seriale interattiva per singole istanze VM o per un intero progetto.

Attivare l'accesso per un progetto

L'abilitazione dell'accesso alla console seriale interattiva in un progetto consente l'accesso a tutte le istanze VM che fanno parte del progetto.

Per impostazione predefinita, l'accesso alla porta seriale interattiva è disattivato. Puoi anche disattivarla esplicitamente impostando la chiave serial-port-enable su FALSE. In entrambi i casi, qualsiasi impostazione per istanza sostituisce l'impostazione a livello di progetto o predefinita.

Console

  1. Nella console Google Cloud, vai alla pagina Metadati.

    Vai a Metadati

  2. Fai clic su Modifica per modificare le voci dei metadati.
  3. Aggiungi una nuova voce che utilizzi la chiave serial-port-enable e il valore TRUE.
  4. Salva le modifiche.

gcloud

Utilizzando Google Cloud CLI, inserisci il comando project-info add-metadata come segue:

gcloud compute project-info add-metadata \
    --metadata serial-port-enable=TRUE

REST

Nell'API, invia una richiesta al metodo projects().setCommonInstanceMetadata fornendo la chiave serial-port-enable con un valore di TRUE:

{
 "fingerprint": "FikclA7UBC0=",
 "items": [
  {
   "key": "serial-port-enable",
   "value": "TRUE"
  }
 ]
}

Attivazione dell'accesso per un'istanza VM

Attiva l'accesso alla console seriale interattiva per un'istanza specifica. Un'impostazione per istanza, se esistente, sostituisce qualsiasi impostazione a livello di progetto. Puoi anche disattivare l'accesso per un'istanza specifica, anche se l'accesso è abilitato a livello di progetto, impostando serial-port-enable su FALSE anziché TRUE. Analogamente, puoi attivare l'accesso per una o più istanze anche se è disabilitato per il progetto, esplicitamente o per impostazione predefinita.

Console

  1. Nella console Google Cloud, vai alla pagina Istanze VM.

    Vai alla pagina Istanze VM

  2. Fai clic sull'istanza per cui vuoi attivare l'accesso.
  3. Fai clic su Modifica.
  4. Nella sezione Accesso remoto, attiva/disattiva la casella di controllo Abilita connessione a porte seriali.
  5. Salva le modifiche.

gcloud

Utilizzando Google Cloud CLI, inserisci il comando instances add-metadata sostituendo instance-name con il nome della tua istanza.

gcloud compute instances add-metadata instance-name \
    --metadata serial-port-enable=TRUE

REST

Nell'API, invia una richiesta al metodo instances().setMetadata con la chiave serial-port-enable e un valore TRUE:

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances/example-instance/setMetadata
{
 "fingerprint": "zhma6O1w2l8=",
 "items": [
  {
   "key": "serial-port-enable",
   "value": "TRUE"
  }
 ]
}

Configurare la console seriale per un'istanza bare metal

Per le istanze bare metal, aumenta la velocità in bit, nota anche come velocità in baud, della console seriale a 115.200 bit/s (~11,5 kB/sec). L'utilizzo di una velocità inferiore comporta un output della console confuso o mancante.

La configurazione del bootloader varia in base ai sistemi operativi e alle relative versioni. Per istruzioni, consulta la documentazione del distributore del sistema operativo.

Se modifichi la velocità in bit sulla riga di comando per la sessione corrente, utilizza un comando simile al seguente:

console=ttyS0,115200

Se modifichi la configurazione di GRUB, utilizza un comando simile al seguente:

serial --speed=115200

Assicurati di aggiornare la configurazione effettiva del bootloader. Per farlo, puoi usare update-grub, grub2-mkconfig o un comando simile.

Connessione a una console seriale

Compute Engine offre gateway di console seriali regionali per ogni regione Google Cloud. Dopo aver abilitato l'accesso interattivo per la console seriale di una VM, puoi collegarti a una console seriale regionale.

La console seriale autentica gli utenti con chiavi SSH. Nello specifico, devi aggiungere la chiave SSH pubblica ai metadati del progetto o dell'istanza e archiviare la chiave privata sulla macchina locale da cui vuoi connetterti. Gcloud CLI e la console Google Cloud aggiungono automaticamente le chiavi SSH al progetto. Se utilizzi un client di terze parti, potrebbe essere necessario aggiungere manualmente le chiavi SSH.

Console

Per connetterti alla console seriale regionale di una VM:

  1. Nella console Google Cloud, vai alla pagina Istanze VM.

    Vai alla pagina Istanze VM

  2. Fai clic sull'istanza a cui vuoi connetterti.
  3. In Accesso remoto, fai clic su Connetti alla console seriale per collegarti alla porta predefinita (porta 1).
  4. Se vuoi connetterti a un'altra porta seriale, fai clic sulla Freccia giù accanto al pulsante Connetti a console seriale e modifica il numero di porta di conseguenza.
  5. Per le istanze Windows, apri il menu a discesa accanto al pulsante e connettiti alla porta 2 per accedere alla console seriale.

gcloud

Per connetterti alla console seriale regionale di una VM, utilizza il comando gcloud compute connect-to-serial-port:

  gcloud compute connect-to-serial-port VM_NAME 
--port=PORT_NUMBER

Sostituisci quanto segue:

  • VM_NAME: il nome della VM alla cui console seriale vuoi collegarti.
  • PORT_NUMBER: il numero di porta a cui vuoi connetterti. Per le VM Linux, utilizza 1, per le VM Windows, utilizza 2. Per scoprire di più sui numeri di porta, consulta Informazioni sulla numerazione delle porte seriali.

Altri client SSH

Puoi connetterti alla console seriale di un'istanza utilizzando altri client SSH di terze parti, a condizione che il client ti consenta di connetterti alla porta TCP 9600.

Per connetterti alla console seriale regionale di una VM, esegui uno dei seguenti comandi, a seconda del sistema operativo della VM:

  • Per connetterti a una VM Linux:

    ssh -i PRIVATE_SSH_KEY_FILE -p 9600 PROJECT_ID.ZONE.VM_NAME.USERNAME.OPTIONS@REGION-ssh-serialport.googleapis.com
    
  • Per connetterti a una VM Windows:

    ssh -i PRIVATE_SSH_KEY_FILE -p 9600 PROJECT_ID.ZONE.VM_NAME.USERNAME.OPTIONS.port=2@REGION-ssh-serialport.googleapis.com
    

Sostituisci quanto segue:

  • PRIVATE_SSH_KEY_FILE: la chiave SSH privata per l'istanza.
  • PROJECT_ID: l'ID progetto per questa istanza VM.
  • ZONE: la zona dell'istanza VM.
  • REGION: la regione dell'istanza VM.
  • VM_NAME: il nome dell'istanza VM.
  • USERNAME: il nome utente che utilizzi per connetterti all'istanza. In genere, si tratta del nome utente sulla tua macchina locale.
  • OPTIONS: opzioni aggiuntive che puoi specificare per questa connessione. Ad esempio, puoi specificare una determinata porta seriale e qualsiasi opzione avanzata. Il numero di porta può essere compreso tra 1 e 4, inclusi. Per scoprire di più sui numeri di porta, consulta Informazioni sulla numerazione delle porte seriali. Se omesso, la connessione verrà effettuata alla porta seriale 1.

Se hai difficoltà a connetterti utilizzando un client SSH di terze parti, puoi eseguire il comando gcloud compute connect-to-serial-port con l'opzione a riga di comando --dry-run per visualizzare il comando SSH che sarebbe stato eseguito per tuo conto. Poi puoi confrontare le opzioni con il comando che stai utilizzando.

Configurare una connessione sicura

Quando utilizzi un client SSH di terze parti diverso da Google Cloud CLI, puoi assicurarti di essere protetto da attacchi di furto d'identità o man-in-the-middle controllando la chiave SSH del server della porta seriale di Google. Per configurare il sistema in modo che controlli la chiave SSH del server, completa i seguenti passaggi:

  1. Scarica la chiave SSH del server per la console seriale che utilizzerai:
  2. Apri il file hosts noti, in genere situato in ~/.ssh/known_hosts.
  3. Aggiungi i contenuti della chiave SSH del server, con il nome host del server premesso alla chiave. Ad esempio, se la chiave del server us-central1 contiene la riga ssh-rsa AAAAB3NzaC1yc..., ~/.ssh/known_hosts deve avere una riga come questa:

    [us-central1-ssh-serialport.googleapis.com]:9600 ssh-rsa AAAAB3NzaC1yc...

Per motivi di sicurezza, Google potrebbe occasionalmente modificare la chiave SSH del server della porta seriale di Google. Se il client non riesce ad autenticare la chiave del server, interrompi immediatamente il tentativo di connessione e completa i passaggi precedenti per scaricare una nuova chiave SSH del server della porta seriale di Google.

Se, dopo aver aggiornato la chiave dell'host, continui a ricevere un errore di autenticazione dell'host dal client, interrompi i tentativi di connessione alla porta seriale e contatta l'Assistenza Google. Non fornire credenziali su una connessione in cui l'autenticazione dell'host non è riuscita.

Disconnessione dalla console seriale

Per scollegarti dalla console seriale:

  1. Premi il tasto ENTER.
  2. Digita ~. (tilde seguita da un punto).

Puoi scoprire altri comandi digitando ~? o esaminando la pagina di manuali per SSH:

man ssh

Non tentare di scollegare il dispositivo utilizzando uno dei seguenti metodi:

  • La combinazione di tasti CTRL+ALT+DELETE o altre combinazioni simili. Questo non funziona perché la console seriale non riconosce le combinazioni della tastiera del PC.

  • Il comando exit o logout non funziona perché l'ospite non è a conoscenza di alcuna connessione di rete o modem. L'utilizzo di questo comando fa sì che la console si chiuda e si riapra e tu rimanga connesso alla sessione. Se vuoi attivare i comandi exit e logout per la sessione, puoi farlo impostando l'opzione on-dtr-low.

Connessione a una console seriale con una richiesta di accesso

Se stai cercando di risolvere un problema con una VM che è stata avviata completamente o stai cercando di risolvere un problema che si verifica dopo che la VM ha superato la modalità utente singolo, è possibile che ti vengano chieste le credenziali di accesso quando cerchi di accedere alla console seriale.

Per impostazione predefinita, le immagini di sistema Linux fornite da Google non sono configurate per consentire accessi basati su password per gli utenti locali. Tuttavia, le immagini di Windows fornite da Google sono configurate per consentire gli accessi basati su password per gli utenti locali.

Se la VM esegue un'immagine preconfigurata con accessi alla porta seriale, devi configurare una password locale sulla VM per poter accedere alla console seriale, se richiesto. Puoi configurare una password locale dopo aver eseguito la connessione alla VM o utilizzando uno script di avvio.

Configurare una password locale utilizzando uno script di avvio

Puoi utilizzare uno script di avvio per configurare una password locale che ti consenta di collegarti alla console seriale durante o dopo la creazione della VM.

Per configurare una password locale in una VM esistente, seleziona una delle seguenti opzioni:

Linux

  1. Nella console Google Cloud, vai alla pagina Istanze VM.

    Vai a Istanze VM

  2. Nella colonna Nome, fai clic sul nome della VM per cui vuoi aggiungere una password locale.

    Viene visualizzata la pagina dei dettagli della VM.

  3. Fai clic su Modifica.

    Viene visualizzata la pagina per modificare i dettagli della VM.

  4. Nella sezione Metadati > Automazione:

    1. Se la VM ha già uno script di avvio, rimuovilo e archivialo in un luogo sicuro.

    2. Aggiungi il seguente script di avvio:

      #!/bin/bash
      useradd USERNAME
      echo USERNAME:PASSWORD | chpasswd
      usermod -aG google-sudoers USERNAME
      

      Sostituisci quanto segue:

      • USERNAME: il nome utente che vuoi aggiungere.

      • PASSWORD: la password per il nome utente. Poiché alcuni sistemi operativi richiedono una lunghezza e una complessità minime della password, specifica una password come segue:

        • Utilizza almeno 12 caratteri.

        • Utilizza una combinazione di lettere maiuscole e minuscole, numeri e simboli.

  5. Fai clic su Salva.

    Viene visualizzata la pagina dei dettagli della VM.

  6. Fai clic su Reimposta.

  7. Connettiti alla console seriale.

  8. Quando richiesto, inserisci i tuoi dati di accesso.

Windows

  1. Nella console Google Cloud, vai alla pagina Istanze VM.

    Vai a Istanze VM

  2. Nella colonna Nome, fai clic sul nome della VM per cui vuoi aggiungere una password locale.

    Viene visualizzata la pagina dei dettagli della VM.

  3. Fai clic su Modifica.

    Viene visualizzata la pagina per modificare i dettagli della VM.

  4. Nella sezione Metadati:

    1. Se la VM ha già uno script di avvio, archivialo in un luogo sicuro e, per eliminarlo, fai clic su Elimina elemento.

    2. Fai clic su Aggiungi elemento.

    3. Nel campo Key (Chiave), inserisci windows-startup-script-cmd.

    4. Nel campo Valore, inserisci lo script seguente:

      net user USERNAME PASSWORD /ADD /Y
      net localgroup administrators USERNAME /ADD
      

      Sostituisci quanto segue:

      • USERNAME: il nome utente che vuoi aggiungere.

      • PASSWORD: la password per il nome utente. Poiché alcuni sistemi operativi richiedono una lunghezza e una complessità minime della password, specifica una password come segue:

        • Utilizza almeno 12 caratteri.

        • Utilizza una combinazione di lettere maiuscole e minuscole, numeri e simboli.

  5. Fai clic su Salva.

    Viene visualizzata la pagina dei dettagli della VM.

  6. Fai clic su Reimposta.

  7. Connettiti alla console seriale.

  8. Quando richiesto, inserisci i tuoi dati di accesso.

Dopo aver creato l'utente, sostituisci lo script di avvio con quello memorizzato in questa sezione.

Configurare una password locale utilizzando passwd sulla VM

Le seguenti istruzioni descrivono come configurare una password locale per un utente su una VM in modo che l'utente possa accedere alla console seriale della VM utilizzando la password specificata.

  1. Connettiti alla VM. Sostituisci instance-name con il nome dell'istanza.

    gcloud compute ssh instance-name
  2. Nella VM, crea una password locale con il seguente comando. In questo modo viene impostata una password per l'utente con cui hai eseguito l'accesso.

    sudo passwd $(whoami)
  3. Segui le istruzioni per creare una password.

  4. Quindi, esci dall'istanza e connettiti alla console seriale.

  5. Inserisci i dati di accesso quando richiesto.

Configurare un accesso su altre porte seriali

Le richieste di accesso sono attivate sulla porta 1 per impostazione predefinita sulla maggior parte dei sistemi operativi Linux. Tuttavia, la porta 1 può spesso essere sovraccaricata dai dati di log e da altre informazioni stampate sulla porta. In alternativa, puoi scegliere di attivare una richiesta di accesso su un'altra porta, ad esempio la porta 2 (ttyS1), eseguendo uno dei seguenti comandi sulla VM. Puoi visualizzare un elenco delle porte disponibili per una VM in Informazioni sulla numerazione delle porte seriali.

La tabella seguente elenca le immagini preconfigurate con un accesso alla console seriale e le porte predefinite.

Sistema operativo Porte con una richiesta di accesso per impostazione predefinita Gestione servizio
CentOS 6 1 upstart
CentOS 7 1 systemd
CoreOS 1 systemd
COS 1 systemd
Debian 8 1 systemd
Debian 9 1 systemd
OpenSUSE 13 1 systemd
OpenSUSE Leap 1 systemd
RHEL 6 1 upstart
RHEL 7 1 systemd
SLES 11 1 sysvinit
SLES 12 1 systemd
Ubuntu 14.04 1 upstart
Ubuntu 16.04 1 systemd
Ubuntu 17.04 1 systemd
Ubuntu 17.10 1 systemd
Windows COM2 N/D

Per attivare le richieste di accesso su altre porte seriali, completa le seguenti istruzioni.

systemd

Per i sistemi operativi Linux che utilizzano systemd:

  • Attiva il servizio temporaneamente fino al riavvio successivo:

    sudo systemctl start serial-getty@ttyS1.service
  • Attiva il servizio in modo permanente, a partire dal riavvio successivo:

    sudo systemctl enable serial-getty@ttyS1.service

upstart

Per i sistemi operativi Linux che utilizzano upstart:

  1. Crea un nuovo file /etc/init/ttyS1.conf per riflettere ttyS1 copiando e modificando un file ttyS0.conf esistente. Ad esempio:

    • Su Ubuntu 14.04:

      sudo sh -c "sed -e s/ttyS0/ttyS1/g < /etc/init/ttyS0.conf > /etc/init/ttyS1.conf"
    • Su RHEL 6.8 e CentOS 6.8

      sudo sh -c "sed -ne '/^# # ttyS0/,/^# exec/p'  < /etc/init/serial.conf  | sed -e 's/ttyS0/ttyS1/g' -e 's/^# *//' > /etc/init/ttyS1.conf"
  2. Avvia da una richiesta di accesso il giorno ttyS1 senza riavviare:

    sudo start ttyS1

sysvinit

Per i sistemi operativi Linux che utilizzano sysvinit, esegui il seguente comando:

 sudo sed -i~ -e &#39;s/^#T([01])/T\1/&#39; /etc/inittab
 sudo telinit q

Informazioni sulla numerazione delle porte seriali

Ogni istanza della macchina virtuale ha quattro porte seriali. Per coerenza con l'API getSerialPortOutput, ogni porta è numerata da 1 a 4. Linux e altri sistemi simili numerano le porte seriali da 0 a 3. Ad esempio, in molte immagini del sistema operativo, i dispositivi corrispondenti vanno da /dev/ttyS0 a /dev/ttyS3. Windows fa riferimento alle porte seriali come COM1-COM4. Per connetterti a ciò che Windows considera COM3 e Linux considera ttyS2, devi specificare la porta 3. Utilizza la seguente tabella per capire a quale porta vuoi connetterti.

Porte seriali delle istanze di macchine virtuali Porte seriali Linux standard Porte COM di Windows
1 /dev/ttyS0 COM1
2 /dev/ttyS1 COM2
3 /dev/ttyS2 COM3
4 /dev/ttyS3 COM4

Tieni presente che molte immagini Linux utilizzano la porta 1 (/dev/ttyS0) per registrare i messaggi del kernel e dei programmi di sistema.

Invio di una interruzione seriale

La funzionalità della chiave Magic SysRq ti consente di eseguire attività di basso livello indipendentemente dallo stato del sistema. Ad esempio, puoi sincronizzare i file system, riavviare l'istanza, terminare i processi e smontare i file system utilizzando la funzionalità della chiave Magic SysRq.

Per inviare un comando Magic SysRq utilizzando un'interruzione seriale simulata:

  1. Premi il tasto ENTER.
  2. Digita ~B (tilde seguita da B maiuscolo).
  3. Digita il comando Magic SysRq.

Visualizzazione degli audit log della console seriale

Compute Engine fornisce log di controllo per monitorare chi si è connesso e disconnesso dalla console seriale di un'istanza. Per visualizzare i log, devi disporre delle autorizzazioni per Visualizzatore log o essere un visualizzatore o un editor del progetto.

  1. Nella console Google Cloud, vai alla pagina Esplora log.

    Vai a Esplora log

  2. Espandi il menu a discesa e seleziona Instanzia VM GCE.
  3. Nella barra di ricerca, digita ssh-serialport.googleapis.com e premi Invio.
  4. Viene visualizzato un elenco di log di controllo. I log descrivono le connessioni e le disconnessioni da una console seriale. Espandi una delle voci per avere ulteriori informazioni:

    Log di controllo per la console seriale.

Per qualsiasi log di controllo, puoi:

  1. Espandi la proprietà protoPayload.
  2. Cerca methodName per visualizzare l'attività a cui si applica questo log (una richiesta di connessione o disconnessione). Ad esempio, se questo log monitora una disconnessione dalla console seriale, il nome del metodo sarà "google.ssh-serialport.v1.disconnect". Analogamente, un log di connessione conterrebbe "google.ssh-serialport.v1.connect". Una voce di log di controllo viene registrata all'inizio e alla fine di ogni sessione sulla console seriale.

Esistono diverse proprietà dei log di controllo per i diversi tipi di log. Ad esempio, i log di controllo relativi alle connessioni hanno proprietà specifiche per i log di connessione, mentre i log di controllo per le disconnessioni hanno il proprio insieme di proprietà. Esistono alcune proprietà dei log di controllo che vengono condivise anche tra i due tipi di log.

Tutti i log della console seriale

La tabella seguente fornisce le proprietà dei log di controllo e i relativi valori per tutti i log della console seriale:

Proprietà Valore
requestMetadata.callerIp L'indirizzo IP e il numero di porta da cui ha avuto origine la connessione.
serviceName ssh-serialport.googleapis.com
resourceName Una stringa contenente l'ID progetto, la zona, il nome dell'istanza e il numero della porta seriale per indicare a quale console seriale si riferisce. Ad esempio, projects/myproject/zones/us-east1-a/instances/example-instance/SerialPort/2 è il numero di porta 2, noto anche come COM2 o /dev/ttyS1, per l'istanza example-instance.
resource.labels Proprietà che identificano l'ID istanza, la zona e l'ID progetto.
timestamp Un timestamp che indica quando è iniziata o terminata la sessione.
severity NOTICE
operation.id Una stringa ID che identifica in modo univoco la sessione. Puoi utilizzarla per associare una voce di disconnessione alla voce di connessione corrispondente.
operation.producer ssh-serialport.googleapis.com

Log di connessione

La tabella seguente fornisce le proprietà dei log di controllo e i relativi valori specifici per i log di connessione:

Proprietà Valore
methodName google.ssh-serialport.v1.connect
status.message Connection succeeded.
request.serialConsoleOptions Eventuali opzioni specificate con la richiesta, incluso il numero della porta seriale.
request.@type type.googleapis.com/google.compute.SerialConsoleSessionBegin
request.username Il nome utente specificato per questa richiesta. Viene utilizzato per selezionare la chiave pubblica da associare.
operation.first TRUE
status.code Per le richieste di connessione andate a buon fine, un valore status.code di google.rpc.Code.OK indica che l'operazione è stata completata correttamente senza errori. Poiché il valore dell'enum per questa proprietà è 0, la proprietà status.code non viene visualizzata. Tuttavia, qualsiasi codice che verifichi un valore status.code di google.rpc.Code.OK funzionerà come previsto.

Log di disconnessione

La tabella seguente fornisce le proprietà dei log di controllo e i relativi valori specifici per i log di disconnessione:

Proprietà Valore
methodName google.ssh-serialport.v1.disconnect
response.duration La durata della sessione in secondi.
response.@type type.googleapis.com/google.compute.SerialConsoleSessionEnd
operation.last TRUE

Log delle connessioni non riuscite

Quando una connessione non va a buon fine, Compute Engine crea una voce di log di controllo. Un log di connessione non riuscita è molto simile a una voce di connessione riuscita, ma presenta le seguenti proprietà per indicare una connessione non riuscita.

Proprietà Valore
severity ERROR
status.code

Il codice di errore dell'API Google canonico che descrive meglio l'errore. Di seguito sono riportati i possibili codici di errore che potrebbero essere visualizzati:

status.message Il messaggio leggibile per questa voce.

Disattivazione dell'accesso alla console seriale interattiva

Puoi disattivare l'accesso alla console seriale interattiva modificando i metadati dell'istanza o del progetto specifico oppure impostando un criterio dell'organizzazione che disattivi l'accesso alla console seriale interattiva a tutte le istanze VM per uno o più progetti che fanno parte dell'organizzazione.

Disattivazione della console seriale interattiva in una determinata istanza o in un determinato progetto

I proprietari e gli editor dei progetti, nonché gli utenti a cui è stato concesso il ruolo compute.instanceAdmin.v1, possono disattivare l'accesso alla console seriale modificando i metadati della determinata istanza o del progetto. Come per l'attivazione dell'accesso alla console seriale, imposta i metadati serial-port-enable su FALSE:

serial-port-enable=FALSE

Ad esempio, utilizzando l'interfaccia a Google Cloud CLI, puoi applicare questi metadati a un'istanza specifica nel seguente modo:

gcloud compute instances add-metadata instance-name \
    --metadata=serial-port-enable=FALSE

Per applicare i metadati al progetto:

gcloud compute project-info add-metadata \
    --metadata=serial-port-enable=FALSE

Disattivazione dell'accesso alla console seriale interattiva tramite i criteri dell'organizzazione

Se ti è stato assegnato il ruolo orgpolicy.policyAdmin nell'organizzazione, puoi impostare un criterio dell'organizzazione che impedisce l'accesso interattivo alla console seriale, indipendentemente dal fatto che l'accesso alla console seriale interattiva sia abilitato sul server dei metadati. Una volta impostato, il criterio dell'organizzazione sostituisce efficacemente la chiave dei metadati serial-port-enable e nessun utente dell'organizzazione o del progetto può attivare l'accesso alla console seriale interattiva. Per impostazione predefinita, questo vincolo è impostato su FALSE.

Il vincolo per la disattivazione dell'accesso alla console seriale interattiva è il seguente:

compute.disableSerialPortAccess

Completa le seguenti istruzioni per impostare questo criterio nell'organizzazione. Dopo aver configurato un criterio, puoi concedere esenzioni su base di progetto.

gcloud

Per impostare il criterio utilizzando Google Cloud CLI, esegui il comando resource-manager enable-enforce. Sostituisci organization-id con il tuo ID organizzazione. Ad esempio: 1759840282.

gcloud resource-manager org-policies enable-enforce \
    --organization organization-id compute.disableSerialPortAccess

REST

Per impostare un criterio nell'API, invia una richiesta POST al seguente URL. Sostituisci organization-name con il nome dell'organizzazione. Ad esempio: organizations/1759840282.

 POST https://cloudresourcemanager.googleapis.com/v1/organization-name:setOrgPolicy

Il corpo della richiesta deve contenere un oggetto policy con il seguente vincolo:

"constraint": "constraints/compute.disableSerialPortAccess"

Ad esempio:

 {
   "policy":
   {
     "booleanPolicy":
     {
       "enforced": TRUE
     },
     "constraint": "constraints/compute.disableSerialPortAccess"
   }
 }
 

Il criterio è efficace immediatamente, pertanto tutti i progetti dell'organizzazione interromperanno immediatamente l'accesso interattivo alla console seriale.

Per disattivare temporaneamente il criterio, utilizza il comando disable-enforce:

gcloud resource-manager org-policies disable-enforce \
    --organization organization-id compute.disableSerialPortAccess

In alternativa, puoi effettuare una richiesta API in cui il corpo della richiesta imposta il parametro enforced su FALSE:

{
  "policy":
  {
    "booleanPolicy":
    {
      "enforced": FALSE
    },
    "constraint": "constraints/compute.disableSerialPortAccess"
  }
}

Impostazione del criterio dell'organizzazione a livello di progetto

Puoi impostare lo stesso criterio organizzativo su base di progetto. Questa impostazione comporta l'override dell'impostazione a livello di organizzazione.

gcloud

Per disattivare l'applicazione di questo criterio per un progetto specifico. Sostituisci project-id con l'ID del tuo progetto.

gcloud resource-manager org-policies disable-enforce \
    --project project-id compute.disableSerialPortAccess

Puoi attivare l'applicazione di questo criterio utilizzando il comando enable-enforce con gli stessi valori.

REST

Nell'API, invia una richiesta POST al seguente URL per attivare l'accesso alla console seriale interattiva per il progetto, sostituendo project-id con l'ID progetto:

POST https://cloudresourcemanager.googleapis.com/v1/projects/project-id:setOrgPolicy

Il corpo della richiesta deve contenere un oggetto policy con il seguente vincolo:

"constraint": "constraints/compute.disableSerialPortAccess"

Ad esempio:

{
  "policy":
  {
    "booleanPolicy":
    {
      "enforced": FALSE
    },
    "constraint": "constraints/compute.disableSerialPortAccess"
  }
}

Suggerimenti utili

  • Se hai difficoltà a connetterti utilizzando un client SSH standard, ma gcloud compute connect-to-serial-port si connette correttamente, potrebbe essere utile eseguire gcloud compute connect-to-serial-port con l'opzione di riga di comando --dry-run per vedere il comando SSH che sarebbe stato eseguito per tuo conto e confrontare le opzioni con il comando che stai utilizzando.

  • Impostando la velocità in bit, nota anche come velocità in baud, puoi impostare qualsiasi velocità in bit che preferisci, ad esempiostty 9600, ma in genere la funzionalità forza la frequenza effettiva su 115.200 bps (~11,5 kB/sec). Questo perché molte immagini pubbliche hanno per impostazione predefinita velocità in bit lente, ad esempio 9600 sulla console seriale, e si avviano lentamente.

  • Alcune immagini del sistema operativo hanno valori predefiniti sconvenienti sulla porta seriale. Ad esempio, su CentOS 7, il valore predefinito stty icrnl per il tasto Invio sulla console è inviare un CR, noto anche come ^M. La shell bash potrebbe mascherarlo fino a quando non provi a impostare una password, a quel punto potresti chiederti perché sembra bloccata al prompt password:.

  • Alcune immagini pubbliche hanno chiavi di controllo dei job che sono disattivate per impostazione predefinita se colleghi una shell a una porta in determinati modi. Alcuni esempi di queste chiavi includono ^Z e ^C. Il comando setsid potrebbe risolvere il problema. In caso contrario, se visualizzi un messaggio job control is disabled in this shell, fai attenzione a non eseguire comandi che dovrai interrompere.

  • Potrebbe essere utile indicare al sistema le dimensioni della finestra in uso, in modo che bash e gli editor possano gestirla correttamente. In caso contrario, potresti riscontrare un comportamento anomalo della visualizzazione perché bash o gli editor tentano di manipolare la visualizzazione in base a presupposti errati sul numero di righe e colonne disponibili. Utilizza il comando stty rows Y cols X e il flag stty -a per vedere qual è l'impostazione. Ad esempio: stty rows 60 cols 120 (se la finestra è di 120 caratteri per 60 righe).

  • Se, ad esempio, ti connetti tramite SSH dalla macchina A alla macchina B e poi alla macchina C, creando una sessione SSH nidificata, e vuoi utilizzare i comandi tilde (~) per disconnetterti o inviare un segnale di interruzione seriale, dovrai aggiungere al comando un numero sufficiente di caratteri tilde aggiuntivi per raggiungere il client SSH corretto. Un comando che segue una singola tilde viene interpretato dal client SSH sulla macchina A; un comando che segue due tilde consecutive (Invio~~) viene interpretato dal client sulla macchina B e così via. Devi premere Invio una sola volta perché il comando viene passato fino alla destinazione SSH più interna. Questo vale per qualsiasi utilizzo di client SSH che forniscono la funzionalità di sfuggita tilde.

    Se non sai quanti caratteri tilde ti servono, premi il tasto Enter e poi digita i caratteri tilde uno alla volta finché l'istanza non li ripete. Questo echo indica che hai raggiunto la fine della catena e ora sai che per inviare un comando tilde al client SSH più nidificato, devi inserire una tilde in meno rispetto al numero di tilde che hai digitato.

Opzioni avanzate

Puoi anche utilizzare le seguenti opzioni avanzate con la porta seriale.

Controllo del numero massimo di connessioni

Puoi impostare la proprietà max-connections per controllare quante connessioni contemporaneamente possono essere effettuate a questa porta seriale. Il numero predefinito e massimo di connessioni è 5. Ad esempio:

gcloud compute connect-to-serial-port instance-name \
    --port port-number \
    --extra-args max-connections=3
ssh -i private-ssh-key-file -p 9600 project-id.zone.instance-name.username.max-connections=3@ssh-serialport.googleapis.com

Impostazione delle opzioni di riproduzione

Per impostazione predefinita, ogni volta che ti connetti alla console seriale, riceverai un replay delle ultime 10 righe di dati, indipendentemente dal fatto che le ultime 10 righe siano state visualizzate da un altro client SSH. Puoi modificare questa impostazione e controllare il numero e le righe restituite impostando le seguenti opzioni:

  • replay-lines=N: imposta N sul numero di righe da riprodurre. Ad esempio, se N è 50, vengono incluse le ultime 50 righe dell'output della console.
  • replay-bytes=N: riproduce i byte N più recenti. Puoi anche impostare N su new, che riproduce tutto l'output che non è stato ancora inviato a nessun client.
  • replay-from=N: riproduce l'output a partire da un indice di byte assoluto fornito da te. Puoi ottenere l'indice di byte corrente dell'output della console seriale inviando una richiesta getSerialPortOutput. Se imposti replay-from, tutte le altre opzioni di ripetizione vengono ignorate.

Con Google Cloud CLI, aggiungi quanto segue al comando connect-to-serial-port, dove N è il numero specificato di righe (o byte o indice di byte assoluto, a seconda dell'opzione di riproduzione selezionata):

--extra-args replay-lines=N

Se utilizzi un client SSH di terze parti, specifica questa opzione nel comando SSH:

ssh -i private-ssh-key-file -p 9600 myproject.us-central1-f.example-instance.jane.port=3.replay-lines=N@ssh-serialport.googleapis.com

Puoi anche utilizzare una combinazione di queste opzioni. Ad esempio:

replay-lines=N e replay-bytes=new
Riproduci il numero specificato di righe OPPURE riproduci tutto l'output non inviato in precedenza a nessun client, a seconda del valore maggiore. Il primo client che si connette con questa combinazione di flag vedrà tutto l'output inviato alla porta seriale, mentre i client che si connettono successivamente vedranno solo le ultime N righe. Esempi:
gcloud compute connect-to-serial-port instance-name--port port-number --extra-args replay-lines=N,replay-bytes=new
ssh -i private-ssh-key-file -p 9600 project-id.zone.instance-name.username.replay-lines=N.replay-bytes=new@ssh-serialport.googleapis.com
replay-lines=N e replay-bytes=M
Riproduci le righe fino al numero di righe o byte, ma non oltre, descritto da questi flag, a seconda del valore più basso. Questa opzione non riprodurrà più di N o M byte.
gcloud compute connect-to-serial-port instance-name--port port-number --extra-args replay-lines=N,replay-bytes=M
ssh -i private-ssh-key-file -p 9600 project-id.zone.instance-name.username.replay-lines=N.replay-bytes=M@ssh-serialport.googleapis.com

Gestione dell'output perso

L'output più recente di 1 MiB per ogni porta seriale è sempre disponibile e, in genere, il client SSH non dovrebbe perdere alcun output dalla porta seriale. Se, per qualche motivo, il client SSH smette di accettare l'output per un certo periodo di tempo, ma non si disconnette e vengono prodotti più di 1 MiB di nuovi dati, il client SSH potrebbe perdere parte dell'output. Quando il client SSH non accetta i dati abbastanza velocemente da stare al passo con l'output sulla porta della console seriale, puoi impostare la proprietà on-dropped-output per determinare il comportamento della console.

Imposta una delle seguenti opzioni applicabili con questa proprietà:

  • insert-stderr-note: inserisci una nota in stderr del client SSH per indicare che l'output è stato eliminato. Questa è l'opzione predefinita.
  • ignore: ignora l'output e non fa nulla.
  • disconnect: interrompi la connessione.

Ad esempio:

gcloud compute connect-to-serial-port instance-name \
    --port port-number \
    --extra-args on-dropped-output=ignore
ssh -i private-ssh-key-file -p 9600 project-id.zone.instance-name.username.on-dropped-output=ignore@ssh-serialport.googleapis.com

Attivazione della disconnessione tramite i comandi exit o logout

Puoi attivare la disconnessione con i comandi di uscita o di logout impostando la proprietà on-dtr-low su disconnect quando ti connetti alla console seriale.

In Google Cloud CLI, aggiungi il seguente flag al comando connect-to-serial-port:

--extra-args on-dtr-low=disconnect

Se utilizzi un client SSH di terze parti, specifica questa opzione nel comando SSH:

ssh -i private-ssh-key-file -p 9600 myproject.us-central1-f.example-instance.jane.port=3.on-dtr-low=disconnect@ssh-serialport.googleapis.com

L'attivazione dell'opzione disconnect potrebbe causare la disconnessione dell'istanza una o più volte durante il riavvio perché il sistema operativo reimposta le porte seriali durante l'avvio.

L'impostazione predefinita per l'opzione on-dtr-low è none. Se utilizzi l'impostazione predefinita none, puoi riavviare l'istanza senza disconnetterti dalla console seriale, ma la console non si disconnetterà con i normali mezzi, come i comandi exit o logout o le normali combinazioni di tasti come Ctrl+D.

Passaggi successivi