IBM Cloud Logs Routing-Befehlszeilenschnittstelle (CLI)

Die IBM Cloud®-Befehlszeilenschnittstelle stellt zusätzliche Funktionen für Serviceangebote bereit. In diesen Informationen wird beschrieben, wie Sie den Dienst IBM Cloud Logs Routing mithilfe der Befehlszeilenschnittstelle definieren und verwalten können.

Vorbereitende Schritte

Führen Sie die folgenden Schritte aus:

Installieren Sie die IBM Cloud-CLI.
Installieren und konfigurieren Sie die IBM Cloud Logs Routing CLI.

Sie werden über die Befehlszeile benachrichtigt, wenn Aktualisierungen für die IBM Cloud-CLI und -Plug-ins verfügbar sind. Achten Sie darauf, dass Ihre CLI auf dem neuesten Stand ist, damit Sie die aktuellsten Befehle verwenden können. Sie können die aktuelle Version aller installierten Plug-ins anzeigen, indem Sie den Befehl ibmcloud plugin list ausführen.

ibmcloud logs-router route erstellen

Verwenden Sie diesen Befehl, um eine Route zu erstellen, die definiert, wie Daten aus einer oder mehreren Regionen an IBM Cloud Logs Routing Ziele in einem Konto weitergeleitet werden. Eine Route kann in dem Konto verwaltet werden, in dem sie erstellt wurde, oder sie kann vom übergeordneten Unternehmenskonto verwaltet werden.

Ziele müssen IBM Cloud Logs Instanzen sein.

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

Befehlsoptionen

--name ROUTE_NAME

Der Name, der für die Route angegeben werden soll.

Die maximale Länge beträgt 1000 Zeichen. Die Mindestlänge beträgt 1 Zeichen.

Der Name darf keine anderen Sonderzeichen als (space) - . _ : enthalten.

Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

--rules RULES | @RULES-FILE

Routing-Regeln, die in der Reihenfolge ausgewertet werden, in der sie konfiguriert sind.

Muss auf eine in einfache Anführungszeichen eingeschlossene JSON-Zeichenkette oder einen Pfad zu einer JSON-Datei gesetzt werden.

Die maximale Länge beträgt 10 Regeln. Die Mindestlänge beträgt 1 Regel.

Sie können z. B. eine JSON-Zeichenkette wie folgt festlegen oder @filepath verwenden, um die JSON-Zeichenkette zu übergeben:

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

Sie können die JSON-Datei wie folgt formatieren, um alle Daten an die Ziele weiterzuleiten, die in der Regel konfiguriert sind:

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

Die Regeldefinition kann optional Einschlussfilter enthalten. Sie können die JSON-Datei wie folgt formatieren:

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

Dabei gilt:

action

Aktion legt fest, ob IBM Cloud Logs Routing Protokolle auf der Route einschließt oder ausschließt. Es werden zwei Aktionen unterstützt: send und drop. Wenn nichts angegeben wird, werden die Protokolle standardmäßig gesendet.

send: Die Protokolle werden auf der Grundlage der Routing-Regel auf der festgelegten Route gesendet.
drop: Protokolle werden auf der Grundlage der Routing-Regel ausgeschlossen, wenn Protokolle auf der festgelegten Route gesendet werden.

targets

Ziele definieren die IBM Cloud Logs Ziele, an die die Protokolle weitergeleitet werden. Es handelt sich um eine durch Kommata getrennte Liste von Ziel-IDs.

inclusion_filters

Einschlussfilter definieren, welche Daten weitergeleitet werden.

Sie können eine kommagetrennte Liste von Filtern konfigurieren.

Ein Filter wird durch einen Operanden, einen Operator und Werte definiert.

Sie können bis zu 7 Filter pro Regel definieren.

operand

Operand ist der Name der Eigenschaft, für die die operator ausgeführt wird.

Gültige Operanden sind: location.

operator

Es werden zwei Operatoren unterstützt: in und is.

in

Der Wert der Operandeneigenschaft wird mit einer Liste von Werten verglichen.

Sie können bis zu 20 Werte definieren.

is

Der Wert der Operandeneigenschaft wird mit einem einzigen Wert verglichen.

Bei Verwendung von is kann nur 1 Wert angegeben werden.

values

Eine Zeichenfolge oder ein Array von Zeichenfolgen, die mit der Eigenschaft operand verglichen werden, um festzustellen, ob das Protokoll weitergeleitet wird oder nicht.

Wenn is operator verwendet wird, muss values eine einzelne Zeichenfolge enthalten.

Wenn in operator verwendet wird, kann values mehrere Zeichenketten in ein Array aufnehmen.

--managed-by

Gibt an, wie eine Route verwaltet wird.

Eine Route kann lokal in dem Konto verwaltet werden, in dem sie erstellt wurde, indem der Standardwert account gesetzt wird, oder sie kann vom Unternehmenskonto verwaltet werden, indem der Wert enterprise gesetzt wird.

Gültige Werte sind: enterprise, oder account.

Der Standardwert ist "Konto".

Sie können diesen Wert nicht mehr ändern, nachdem die Route erstellt wurde.

--output FORMAT

Wenn JSON angegeben ist, wird die Ausgabe im JSON-Format zurückgegeben. Wenn JSON nicht angegeben wird, erfolgt die Ausgabe in einem Tabellenformat.

help | --help | -h

Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router route update

Verwenden Sie diesen Befehl, um eine Route zu aktualisieren, die definiert, wie Daten aus einer oder mehreren Regionen an IBM Cloud Logs Routing Ziele in einem Konto weitergeleitet werden.

Jeder angegebene Wert, der sich von dem bei der ursprünglichen Erstellung der Route unterscheidet, wird auf den im Befehl angegebenen Wert aktualisiert. Alle zuvor bereitgestellten Konfigurationen, die nicht in der Aktualisierungsanforderung enthalten sind, werden entfernt.

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

Befehlsoptionen

--route ROUTE

Die ID oder der Name der Route.

Die ID ist eine v4 UUID, die die Route eindeutig identifiziert.

Die maximale Länge der ID beträgt 1028 Zeichen. Die Mindestlänge der ID beträgt 24 Zeichen.

--name NAME

Der neue Name, der der Route gegeben werden soll (optional).

Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

--rules RULES | @RULES-FILE

Routing-Regeln, die in der Reihenfolge ausgewertet werden, in der sie konfiguriert sind.

Muss auf eine in einfache Anführungszeichen eingeschlossene JSON-Zeichenkette oder einen Pfad zu einer JSON-Datei gesetzt werden.

Die maximale Länge beträgt 10 Regeln. Die Mindestlänge beträgt 1 Regel.

Behalten Sie Ihre aktuelle Konfiguration zusätzlich zu den Änderungen, die Sie vornehmen müssen. Jede bestehende Regelkonfiguration, die nicht in der Aktualisierung enthalten ist, wird gelöscht.

Sehen Sie sich zum Beispiel das Beispiel einer JSON-formatierten Regeldefinition an oder verwenden Sie @filepath, um die json-Datei zu übergeben:

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

Sie können die JSON-Datei wie folgt formatieren, um alle Daten an die Ziele weiterzuleiten, die in der Regel konfiguriert sind:

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

Die Regeldefinition kann optional Einschlussfilter enthalten. Sie können die JSON-Datei wie folgt formatieren:

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

action

send: Die Protokolle werden auf der Grundlage der Routing-Regel auf der festgelegten Route gesendet.
drop: Protokolle werden auf der Grundlage der Routing-Regel ausgeschlossen, wenn Protokolle auf der festgelegten Route gesendet werden.

targets

Ziele definieren die IBM Cloud Logs Ziele, an die die Protokolle weitergeleitet werden. Es handelt sich um eine durch Kommata getrennte Liste von Ziel-IDs.

inclusion_filters

Einschlussfilter definieren, welche Daten weitergeleitet werden.

Sie können eine kommagetrennte Liste von Filtern konfigurieren.

Ein Filter wird durch einen Operanden, einen Operator und Werte definiert.

Sie können bis zu 7 Filter pro Regel definieren.

operand

Operand ist der Name der Eigenschaft, für die die operator ausgeführt wird.

Gültige Operanden sind: location.

operator

Es werden zwei Operatoren unterstützt: in und is.

in

Der Wert der Operandeneigenschaft wird mit einer Liste von Werten verglichen.

Sie können bis zu 20 Werte definieren.

is

Der Wert der Operandeneigenschaft wird mit einem einzigen Wert verglichen.

Bei Verwendung von is kann nur 1 Wert angegeben werden.

values

Eine Zeichenfolge oder ein Array von Zeichenfolgen, die mit der Eigenschaft operand verglichen werden, um festzustellen, ob das Protokoll weitergeleitet wird oder nicht.

Wenn is operator verwendet wird, muss values eine einzelne Zeichenfolge enthalten.

Wenn in operator verwendet wird, kann values mehrere Zeichenketten in ein Array aufnehmen.

--output FORMAT

Wenn JSON angegeben ist, wird die Ausgabe im JSON-Format zurückgegeben. Wenn JSON nicht angegeben wird, erfolgt die Ausgabe in einem Tabellenformat.

help | --help | -h

Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router route löschen

Verwenden Sie diesen Befehl, um eine IBM Cloud Logs Routing Route zu löschen.

ibmcloud logs-router route delete --route ROUTE

Befehlsoptionen

--route ROUTE: Die ID oder der Name der zu löschenden Route.
--force oder --f: Löscht die Route, ohne dem Benutzer eine zusätzliche Aufforderung zu geben.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router route get

Verwenden Sie diesen Befehl, um Konfigurationsinformationen über eine IBM Cloud Logs Routing Route zu erhalten.

ibmcloud logs-router route get --route ROUTE

Befehlsoptionen

--route ROUTE: Die ID oder der Name der Route.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router Routenliste

Verwenden Sie diesen Befehl, um alle konfigurierten Routen für IBM Cloud Logs Routing im Konto aufzulisten.

ibmcloud logs-router route list

Befehlsoptionen

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router Ziel erstellen

Verwenden Sie diesen Befehl, um ein Ziel zu erstellen, das zur Konfiguration eines Ziels für Plattformmetriken verwendet wird. Sie können Ihre Plattformprotokolle aus allen Regionen an ein einziges Ziel, verschiedene Ziele oder mehrere Ziele senden. Ein Ziel pro Region ist nicht erforderlich. Sie können bis zu 16 Ziele pro Konto definieren.

Ziele müssen IBM Cloud Logs Instanzen sein.

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

Befehlsoptionen

--region REGION

Name der Region, z. B. us-south oder eu-gb. Wird nichts angegeben, wird die Region verwendet, in der man angemeldet ist oder die man anvisiert. Dies ist optional.

--name NAME

Der Name, der für das Ziel angegeben werden soll.

Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

--destination-crn DESTINATION-CRN

Die CRN der Dienstinstanz oder Ressource, die die von IBM Cloud Logs Routing gesendeten Protokolle empfangen soll. Stellen Sie sicher, dass Sie eine Dienstberechtigung zwischen IBM Cloud Logs Routing und Ihrer IBM Cloud Ressource haben. Weitere Informationen finden Sie unter Verwalten von Berechtigungen zur Gewährung von Zugriff zwischen Diensten...

[--managed-by MANAGED-BY] Dies ist optional. Gibt an, wer dieses Ziel verwaltet. Optional zum Zeitpunkt der Erstellung. Bei der Einstellung "Unternehmen" wird das Ziel von Unternehmen verwaltet und kann nur von Identitäten geändert werden, die für die Unternehmensaktionen autorisiert sind. Wird diese Angabe weggelassen oder auf "Konto" gesetzt, wird das Ziel vom untergeordneten Konto verwaltet. Dieser Wert ist nach der Erstellung unveränderlich. Zulässige Werte sind: Unternehmen, Konto.

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router ziel aktualisierung

Verwenden Sie diesen Befehl, um ein Ziel zu aktualisieren, das zur Konfiguration eines Ziels für Plattformmetriken verwendet werden soll.

Ziele müssen IBM Cloud Logs Instanzen sein.

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

Befehlsoptionen

--target TARGET Die ID oder der Name des Ziels.

--name NAME

Der neue Name, der dem Ziel gegeben werden soll.

Schließen Sie keine personenbezogenen Daten in Ressourcennamen ein.

--destination-crn DESTINATION_CRN

help | --help | -h

Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router ziel löschen

Verwenden Sie diesen Befehl, um ein Ziel zu löschen.

ibmcloud logs-router target delete --target TARGET

Befehlsoptionen

--target TARGET: Die ID oder der Name des Ziels.
--force | -f: Löscht das Ziel, ohne dem Benutzer eine zusätzliche Aufforderung zu geben.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router ziel get

Verwenden Sie diesen Befehl, um Informationen über ein IBM Cloud Logs Routing Ziel abzurufen.

ibmcloud logs-router target get --target TARGET

Befehlsoptionen

--target TARGET: Die ID oder der Name des Ziels.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router Zielliste

Verwenden Sie diesen Befehl, um alle konfigurierten Ziele für IBM Cloud Logs Routing aufzulisten.

ibmcloud logs-router target list

Befehlsoptionen

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router Einstellung get

Verwenden Sie diesen Befehl, um die Einstellungen für die IBM Cloud Logs Routing Kontoebenen-Konfigurationen abzurufen.

ibmcloud logs-router setting get

Befehlsoptionen

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router einstellung aktualisieren

Verwenden Sie diesen Befehl, um aktuelle Einstellungen wie die Standardziele, zulässige Zielregionen, primäre und sekundäre Metadatenregionen in IBM Cloud Logs Routing zu ändern. Alle Werte, die sich von denen unterscheiden, die bei der ursprünglichen Erstellung des Ziels angegeben wurden, werden auf den im Befehl angegebenen Wert aktualisiert. Wenn keine Optionen angegeben werden, werden die aktuellen Einstellungen zurückgegeben.

Bevor Sie öffentliche Endpunkte durch Festlegen von --private-api-endpoint-only TRUE inaktivieren, stellen Sie sicher, dass Ihr Konto Zugriff auf den privaten Endpunkt hat. Sie können dies tun, indem Sie den Befehl ibmcloud account showausführen. Wenn VRF Enabled auf true gesetzt ist und Service Endpoint Enabled auf true gesetzt ist, haben Sie Zugriff auf den privaten Endpunkt. Wenn Sie keinen Zugriff auf den privaten Endpunkt haben, können Sie den öffentlichen Endpunkt nicht aktivieren. Der Zugriff auf den privaten Endpunkt ist erforderlich, um den öffentlichen Endpunkt zu aktivieren.

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]

Befehlsoptionen

--api-version: API-Version für IBM Cloud Logs Routing Service im IBM Cloud Konto. Gültige Werte sind 1 und 3. Der Standardwert ist 1. Sie können nur dann von 1 auf 3 aktualisieren, um Ihre Servicekonfiguration zu migrieren, wenn Sie unter V1 gültige Ziele und Tenants erstellt haben. Beachten Sie, dass es nach dieser Aktualisierung keine Möglichkeit gibt, zu Version 1 zurückzukehren. Weitere Informationen finden Sie unter https://ibm.biz/lr-v3migration.
--backup-metadata-region: Sicherungsbereich, der für die Sicherung der Metadaten von IBM Cloud Logs Routing verwendet wird. Maximal zulässige Länge: 256 Zeichen. Die Mindestlänge beträgt 3 Zeichen.
--default-targets: Ziele, die Protokolle erhalten, die nicht explizit in den Routing-Regeln des Kontos IBM Cloud Logs Routing verwaltet werden. Sie können bis zu 2 Ziele definieren. Die Mindestanzahl der Ziele ist 0.
--permitted-target-regions: Durch Kommata getrennte Liste der Regionen, die von IBM Cloud Logs Routing unterstützt werden und in denen Benutzer Ziele im Konto erstellen können. Weitere Informationen finden Sie unter https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations. Die maximale Länge beträgt 16 Regionen. Die Mindestlänge beträgt 0 Regionen.
--primary-metadata-region: Primäre Region, die für die Sicherung der Metadaten von IBM Cloud Logs Routing verwendet wird. Maximal zulässige Länge: 256 Zeichen. Die Mindestlänge beträgt 3 Zeichen.
--private-api-endpoint-only: Unterstützte Endgerätekonnektivität. Setzen Sie diesen Wert auf "false", um auf die API über das öffentliche Netz zuzugreifen. Setzen Sie diesen Wert auf "true", um nur über das private Netz auf die API zuzugreifen.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router migrate abgeschlossen

Verwenden Sie diesen Befehl, um die Migrationsprotokolle von Routing-Version 1 auf Version 3 zu vervollständigen. Der Migrationsstatus muss PENDING_COMPLETION sein, um diesen Befehl verwenden zu können.

ibmcloud logs-router migrate complete

Befehlsoptionen

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router migrieren generieren

Verwenden Sie diesen Befehl, um die asynchrone Migration des Protokollroutings von Version 1 auf Version 3 zu starten. Der Migrationsstatus muss VORHER sein, um diesen Befehl zu verwenden.

ibmcloud logs-router migrate generate

Befehlsoptionen

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router migrieren löschen

Verwenden Sie diesen Befehl, um alle Protokolle für Routing-Routen und -Ziele der Version 3 zu löschen und den Migrationsstatus auf BEFORE zurückzusetzen. Nur zulässig, wenn der Status PENDING_COMPLETION oder BEFORE ist.

ibmcloud logs-router migrate delete

Befehlsoptionen

--force|-f`: Löscht den Vorgang ohne Bestätigung.
help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.

ibmcloud logs-router migrate status

Verwenden Sie diesen Befehl, um die Statusprotokolle des Routing-Migrationsstatus und Versionsinformationen abzurufen. Die möglichen Zustände sind: COMPLETE, BEFORE, IN_PROGRESS und PENDING_COMPLETION.

ibmcloud logs-router migrate status

Befehlsoptionen

help | --help | -h: Hiermit können Sie Optionen auflisten, die für den Befehl verfügbar sind.