CLI IBM Cloud Logs Routing

L'interfaccia a riga di comando (CLI) di IBM Cloud® offre funzionalità aggiuntive per le offerte di servizi. Queste informazioni descrivono come utilizzare la CLI per definire e gestire il servizio IBM Cloud Logs Routing utilizzando la CLI.

Prima di iniziare

Completa i seguenti passi:

Installa la CLI IBM Cloud.
Installare e configurare il sito IBM Cloud Logs Routing CLI.

L'utente viene avvisato tramite la riga di comando quando sono disponibili aggiornamenti della CLI e dei plug-in di IBM Cloud. Assicuratevi di mantenere aggiornata la vostra CLI in modo da poter utilizzare i comandi più recenti. Puoi visualizzare la versione corrente di tutti i plugin installati eseguendo ibmcloud plugin list.

ibmcloud logs-router route create

Usare questo comando per creare un percorso che definisce come i dati vengono instradati ai target IBM Cloud Logs Routing in un account da una o più regioni. Un percorso può essere gestito nell'account in cui è stato creato o può essere gestito dall'account principale dell'impresa.

I target devono essere istanze di IBM Cloud Logs.

ibmcloud logs-router route create --name ROUTE_NAME ( --rules RULES | @RULES-FILE) [--managed-by MANAGED-BY] [--output FORMAT]

Opzioni comando

--name ROUTE_NAME

Il nome da assegnare al percorso.

La lunghezza massima è di 1000 caratteri. La lunghezza minima è di 1 carattere.

Il nome non può includere caratteri speciali diversi da (space) - . _ :.

Non includere informazioni di identificazione personale (PII) nei nomi delle risorse.

--rules RULES | @RULES-FILE

Regole di routing che verranno valutate nell'ordine in cui sono state configurate.

Deve essere impostato su una stringa JSON racchiusa tra virgolette singole o su un percorso di un file JSON.

La lunghezza massima è di 10 regole. La lunghezza minima è di 1 regola.

Ad esempio, si può impostare una stringa JSON come segue o usare @filepath per passare il json:

--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south","eu-de"]}]}]'

È possibile formattare il file JSON come segue per instradare tutti i dati alle destinazioni configurate nella regola:

[
  {
    "targets": [{"id":"ID1"},{"id":"ID2"}]
  }
]

La definizione della regola può includere facoltativamente dei filtri di inclusione. È possibile formattare il file JSON come segue:

[{
    "action": "send",
    "targets": [{
      "id":"11111111-1111-1111-1111-111111111111"
    }],
    "inclusion_filters": [
        {
          "operand": "location",
          "operator": "in",
          "values": [
            "us-south",
            "eu-de"
          ]
        }
    ]
 }]

Dove:

action

L'azione definisce se IBM Cloud Logs Routing include o esclude i registri sul percorso. Sono supportate due azioni: send e drop. Se non viene specificato, l'azione predefinita è l'invio dei log.

send: I registri vengono inviati, in base alla regola di routing, sul percorso definito.
drop: I registri vengono esclusi, in base alla regola di instradamento, quando i registri vengono inviati sul percorso definito.

targets

I target definiscono le destinazioni di IBM Cloud Logs dove vengono instradati i log. È un elenco separato da virgole di ID di destinazione.

inclusion_filters

I filtri di inclusione definiscono l'instradamento dei dati.

È possibile configurare un elenco di filtri separati da virgole.

Un filtro è definito da un operando, un operatore e dei valori.

È possibile definire un massimo di 7 filtri per regola.

operand

L'operando è il nome della proprietà su cui viene eseguito operator.

Gli operandi validi sono: location.

operator

Sono supportati due operatori: in e is.

in

Il valore della proprietà dell'operando viene confrontato con un elenco di valori.

È possibile definire fino a 20 valori.

is

Il valore della proprietà dell'operando viene confrontato con un singolo valore.

Quando si utilizza is, è possibile specificare solo 1 valore.

values

Una stringa, o un array di stringhe, da confrontare con la proprietà operand per determinare se il log è instradato o meno.

Quando si utilizza is operator, values deve includere una singola stringa.

Quando si utilizza in operator, values può includere più stringhe in un array.

--managed-by

Identifica come viene gestito un percorso.

Una rotta può essere gestita localmente nell'account in cui viene creata, impostando il valore predefinito account, oppure può essere gestita dall'account aziendale, impostando il valore enterprise.

I valori validi sono: enterprise, o account.

Il valore predefinito è "account".

Non è possibile modificare questo valore dopo la creazione del percorso.

--output FORMAT

Se viene specificato JSON, l'output viene restituito in formato JSON. Se JSON non è specificato, l'output viene restituito in formato tabellare.

help | --help | -h

Elenca le opzioni disponibili per il comando.

ibmcloud logs-router aggiornamento della rotta

Usare questo comando per aggiornare un percorso che definisce il modo in cui i dati vengono instradati ai target IBM Cloud Logs Routing in un account da una o più regioni.

Qualsiasi valore specificato che sia diverso da quello della creazione originaria della rotta viene aggiornato al valore specificato nel comando. Qualsiasi configurazione precedentemente distribuita e non inclusa nella richiesta di aggiornamento viene rimossa.

ibmcloud logs-router route update --route ROUTE [--name NAME] [--rules RULES | @RULES-FILE]

Opzioni comando

--route ROUTE

L'ID o il nome dell'instradamento.

L'ID è un UUID v4 che identifica in modo univoco la rotta.

La lunghezza massima dell'ID è di 1028 caratteri. La lunghezza minima dell'ID è di 24 caratteri.

--name NAME

Il nuovo nome da assegnare al percorso (opzionale).

Non includere informazioni di identificazione personale (PII) nei nomi delle risorse.

--rules RULES | @RULES-FILE

Regole di routing che verranno valutate nell'ordine in cui sono state configurate.

Deve essere impostato su una stringa JSON racchiusa tra virgolette singole o su un percorso di un file JSON.

La lunghezza massima è di 10 regole. La lunghezza minima è di 1 regola.

Mantenere la configurazione attuale oltre alle modifiche da apportare. Qualsiasi configurazione di regola esistente non inclusa nell'aggiornamento viene eliminata.

Ad esempio, vedere l'esempio di una definizione di regola formattata in JSON o usare @filepath per passare il json:

--rules '[{"action": "send", "targets":[{"id": "11111111-1111-1111-1111-111111111111"}], "inclusion_filters":[{"operand": "location","operator": "is","values": ["us-south","eu-de","eu-gb"]}]}]'

È possibile formattare il file JSON come segue per instradare tutti i dati alle destinazioni configurate nella regola:

[
  {
    "targets": [{"id":"ID1"},{"id":"ID2"},{"id":"ID3"}]
  }
]

La definizione della regola può includere facoltativamente dei filtri di inclusione. È possibile formattare il file JSON come segue:

[{
    "action": "send",
    "targets": [{
      "id":"11111111-1111-1111-1111-111111111111"
    }],
    "inclusion_filters": [
        {
          "operand": "location",
          "operator": "in",
          "values": [
            "us-south",
            "eu-de",
            "eu-gb"
          ]
        }
    ]
 }]

action

L'azione definisce se IBM Cloud Logs Routing include o esclude i registri sul percorso. Sono supportate due azioni: send e drop. Se non viene specificato, l'azione predefinita è l'invio dei log.

send: I registri vengono inviati, in base alla regola di routing, sul percorso definito.
drop: I registri vengono esclusi, in base alla regola di instradamento, quando i registri vengono inviati sul percorso definito.

targets

I target definiscono le destinazioni di IBM Cloud Logs dove vengono instradati i log. È un elenco separato da virgole di ID di destinazione.

inclusion_filters

I filtri di inclusione definiscono l'instradamento dei dati.

È possibile configurare un elenco di filtri separati da virgole.

Un filtro è definito da un operando, un operatore e dei valori.

È possibile definire un massimo di 7 filtri per regola.

operand

L'operando è il nome della proprietà su cui viene eseguito operator.

Gli operandi validi sono: location.

operator

Sono supportati due operatori: in e is.

in

Il valore della proprietà dell'operando viene confrontato con un elenco di valori.

È possibile definire fino a 20 valori.

is

Il valore della proprietà dell'operando viene confrontato con un singolo valore.

Quando si utilizza is, è possibile specificare solo 1 valore.

values

Una stringa, o un array di stringhe, da confrontare con la proprietà operand per determinare se il log è instradato o meno.

Quando si utilizza is operator, values deve includere una singola stringa.

Quando si utilizza in operator, values può includere più stringhe in un array.

--output FORMAT

Se viene specificato JSON, l'output viene restituito in formato JSON. Se JSON non è specificato, l'output viene restituito in formato tabellare.

help | --help | -h

Elenca le opzioni disponibili per il comando.

ibmcloud logs-router route elimina

Utilizzare questo comando per eliminare una rotta IBM Cloud Logs Routing.

ibmcloud logs-router route delete --route ROUTE

Opzioni comando

--route ROUTE: L'ID o il nome della rotta da eliminare.
--force oppure --f: Elimina il percorso senza fornire all'utente alcuna richiesta aggiuntiva.
help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router route get

Utilizzare questo comando per ottenere informazioni sulla configurazione di una rotta IBM Cloud Logs Routing.

ibmcloud logs-router route get --route ROUTE

Opzioni comando

--route ROUTE: L'ID o il nome dell'instradamento.
help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router elenco rotte

Utilizzare questo comando per elencare tutte le rotte configurate per IBM Cloud Logs Routing nell'account.

ibmcloud logs-router route list

Opzioni comando

help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router target create

Usare questo comando per creare un target da usare per configurare una destinazione per le metriche della piattaforma. È possibile inviare i log della piattaforma da tutte le regioni a un singolo target, a diversi target o a più target. Non è necessario un obiettivo per regione. È possibile definire fino a 16 obiettivi per account.

I target devono essere istanze di IBM Cloud Logs.

ibmcloud logs-router target create --name NAME --destination-crn DESTINATION-CRN [--region REGION] [--managed-by MANAGED-BY]

Opzioni comando

--region REGION

Nome della regione, ad esempio us-south o eu-gb. Se non viene specificato, viene utilizzata la regione in cui è stato effettuato l'accesso o in cui si è puntato. Questo è facoltativo.

--name NAME

Il nome da assegnare alla destinazione.

Non includere informazioni di identificazione personale (PII) nei nomi delle risorse.

--destination-crn DESTINATION-CRN

Il CRN dell'istanza di servizio o della risorsa che deve ricevere i log inviati da IBM Cloud Logs Routing. Assicurarsi di avere un'autorizzazione al servizio tra IBM Cloud Logs Routing e la risorsa IBM Cloud. Per ulteriori informazioni, vedere Gestione delle autorizzazioni per garantire l'accesso tra i servizi.

[--managed-by MANAGED-BY] Questo è facoltativo. Identifica chi gestisce questo obiettivo. Opzionale al momento della creazione. Se impostato su "enterprise", la destinazione diventa gestita dall'azienda e può essere modificata solo dalle identità autorizzate alle azioni aziendali. Se omesso o impostato su 'account', la destinazione è gestita dall'account figlio. Questo valore è immutabile dopo la creazione. I valori ammessi sono: impresa, conto.

help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router target update

Usare questo comando per aggiornare un target da usare per configurare una destinazione per le metriche della piattaforma.

I target devono essere istanze di IBM Cloud Logs.

ibmcloud logs-router target update --target TARGET [--name NAME] [--destination-crn DESTINATION-CRN]

Opzioni comando

--target TARGET L'id o il nome della destinazione.

--name NAME

Il nuovo nome da assegnare alla destinazione.

Non includere informazioni di identificazione personale (PII) nei nomi delle risorse.

--destination-crn DESTINATION_CRN

help | --help | -h

Elenca le opzioni disponibili per il comando.

ibmcloud logs-router target elimina

Utilizzare questo comando per eliminare un target.

ibmcloud logs-router target delete --target TARGET

Opzioni comando

--target TARGET: L'ID o il nome della destinazione.
--force | -f: Elimina la destinazione senza fornire all'utente alcuna richiesta aggiuntiva.
help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router target get

Usare questo comando per ottenere informazioni su un target IBM Cloud Logs Routing.

ibmcloud logs-router target get --target TARGET

Opzioni comando

--target TARGET: L'ID o il nome della destinazione.
help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router elenco di destinazione

Utilizzare questo comando per elencare tutti i target configurati per IBM Cloud Logs Routing.

ibmcloud logs-router target list

Opzioni comando

help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router impostazione get

Usare questo comando per ottenere le impostazioni per le configurazioni a livello di account di IBM Cloud Logs Routing.

ibmcloud logs-router setting get

Opzioni comando

help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router aggiornamento impostazioni

Utilizzare questo comando per modificare le impostazioni correnti, come i target predefiniti, le regioni target consentite, le regioni metadati primarie e secondarie in IBM Cloud Logs Routing. Qualsiasi valore diverso da quello creato originariamente viene aggiornato al valore specificato nel comando. Se non vengono specificate opzioni, vengono restituite le impostazioni correnti.

Prima di disabilitare gli endpoint pubblici impostando --private-api-endpoint-only TRUE, accertarsi che l'account abbia accesso all'endpoint privato. È possibile farlo eseguendo il comando ibmcloud account show. Se VRF Enabled è true e Service Endpoint Enabled è true, si ha accesso all'endpoint privato. Se non si ha accesso all'endpoint privato, non è possibile abilitare l'endpoint pubblico. L'accesso all'endpoint privato è necessario per abilitare l'endpoint pubblico.

ibmcloud logs-router setting update [--default-targets DEFAULT-TARGETS] [--permitted-target-regions PERMITTED-TARGET-REGIONS] [--primary-metadata-region PRIMARY-METADATA-REGION] [--backup-metadata-region BACKUP-METADATA-REGION] [--private-api-endpoint-only=PRIVATE-API-ENDPOINT-ONLY]

Opzioni comando

--api-version: Versione API per il servizio IBM Cloud Logs Routing nell'account IBM Cloud. I valori validi sono 1 e 3. Il valore predefinito è 1. È possibile aggiornare da 1 a 3 per migrare la configurazione del servizio solo se sono stati creati target e tenant validi in V1. Si noti che una volta effettuato l'aggiornamento, non c'è alcuna opzione per tornare alla versione 1. Per ulteriori informazioni, vedere https://ibm.biz/lr-v3migration.
--backup-metadata-region: Regione di backup utilizzata per il backup dei metadati di IBM Cloud Logs Routing. La lunghezza massima è di 256 caratteri. La lunghezza minima è di 3 caratteri.
--default-targets: I bersagli che ricevono i registri non gestiti esplicitamente nelle regole di instradamento dell'account IBM Cloud Logs Routing. È possibile definire fino a 2 target. Il numero minimo di obiettivi è 0.
--permitted-target-regions: Elenco separato da virgole delle regioni supportate da IBM Cloud Logs Routing in cui gli utenti possono creare obiettivi nell'account. Per ulteriori informazioni, vedere https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations. La lunghezza massima è di 16 regioni. La lunghezza minima è di 0 regioni.
--primary-metadata-region: Regione primaria utilizzata per il backup dei metadati di IBM Cloud Logs Routing. La lunghezza massima è di 256 caratteri. La lunghezza minima è di 3 caratteri.
--private-api-endpoint-only: Connettività endpoint supportata. Impostare questo valore su "false" per accedere all'API attraverso la rete pubblica. Impostare questo valore su "true" per accedere all'API solo attraverso la rete privata.
help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router migrazione completata

Usare questo comando per completare i log di migrazione dalla versione 1 alla versione 3. Per utilizzare questo comando, lo stato della migrazione deve essere PENDING_COMPLETION.

ibmcloud logs-router migrate complete

Opzioni comando

help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router migrate generate

Usare questo comando per avviare la migrazione asincrona del routing dei registri dalla versione 1 alla versione 3. Per utilizzare questo comando, lo stato di migrazione deve essere PRIMA.

ibmcloud logs-router migrate generate

Opzioni comando

help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router migrate delete

Usare questo comando per eliminare tutti i log delle rotte e delle destinazioni della versione 3 del routing e reimpostare lo stato di migrazione su PRIMA. È consentito solo quando lo stato è PENDING_COMPLETION o BEFORE.

ibmcloud logs-router migrate delete

Opzioni comando

--force|-f`: Cancella l'operazione senza conferma.
help | --help | -h: Elenca le opzioni disponibili per il comando.

ibmcloud logs-router migrate status

Usare questo comando per recuperare i registri di stato della migrazione di routing e le informazioni sulla versione. Gli stati possibili sono: COMPLETE, BEFORE, IN_PROGRESS e PENDING_COMPLETION.

ibmcloud logs-router migrate status

Opzioni comando

help | --help | -h: Elenca le opzioni disponibili per il comando.