Interface de ligne de commande IBM Cloud Logs Routing

L'interface de ligne de commande IBM Cloud® inclut des fonctions supplémentaires pour les offres de service. Ces informations décrivent comment utiliser le CLI pour définir et gérer le service IBM Cloud Logs Routing à l'aide du CLI.

Avant de commencer

Procédez comme suit :

  1. Installez l'interface de ligne de commande IBM Cloud.

  2. Installer et configurer le CLI IBM Cloud Logs Routing.

Vous êtes averti sur la ligne de commande lorsque des mises à jour de l'interface de ligne de commande et des plug-ins IBM Cloud sont disponibles. Veillez à maintenir votre CLI à jour afin de pouvoir utiliser les commandes les plus récentes. Vous pouvez afficher la version actuelle de tous les plug-ins installés en exécutant la commande ibmcloud plugin list.

ibmcloud logs-router route create

Cette commande permet de créer un itinéraire qui définit la manière dont les données sont acheminées vers les cibles IBM Cloud Logs Routing d'un compte à partir d'une ou de plusieurs régions. Un itinéraire peut être géré dans le compte où il a été créé ou par le compte parent de l'entreprise.

Les cibles doivent être des instances IBM Cloud Logs.

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

Options de commande

--name ROUTE_NAME

Nom à attribuer à la route.

La longueur maximale est de 1000 caractères. La longueur minimale est de 1 caractère.

Le nom ne peut pas contenir de caractères spéciaux autres que (space) - . _ :.

N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

--rules RULES | @RULES-FILE

Règles de routage qui seront évaluées dans l'ordre dans lequel elles sont configurées.

Doit être défini comme une chaîne JSON entre guillemets simples ou un chemin d'accès à un fichier JSON.

La longueur maximale est de 10 règles. La longueur minimale est de 1 règle.

Par exemple, vous pouvez définir une chaîne JSON comme suit ou utiliser @filepath pour transmettre le json :

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

Vous pouvez formater le fichier JSON comme suit pour acheminer toutes les données vers les cibles configurées dans la règle :

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

La définition de la règle peut éventuellement inclure des filtres d'inclusion. Vous pouvez formater le fichier JSON comme suit :

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

Où :

action

Action définit si IBM Cloud Logs Routing inclut ou exclut les journaux sur l'itinéraire. Deux actions sont prises en charge : send et drop. Si elle n'est pas spécifiée, l'action par défaut est d'envoyer les journaux.

send
Les journaux sont envoyés, en fonction de la règle de routage, sur l'itinéraire défini.
drop
Les journaux sont exclus, en fonction de la règle de routage, lorsqu'ils sont envoyés sur l'itinéraire défini.
targets

Les cibles définissent les destinations IBM Cloud Logs où les journaux sont acheminés. Il s'agit d'une liste d'ID de cibles séparées par des virgules.

inclusion_filters

Les filtres d'inclusion définissent les données qui sont acheminées.

Vous pouvez configurer une liste de filtres séparés par des virgules.

Un filtre est défini par un opérande, un opérateur et des valeurs.

Vous pouvez définir un maximum de 7 filtres par règle.

operand

Operand est le nom de la propriété sur laquelle operator est exécuté.

Les opérandes valides sont les suivants : location.

operator

Deux opérateurs sont pris en charge : in et is.

in

La valeur de la propriété de l'opérande est comparée à une liste de valeurs.

Vous pouvez définir jusqu'à 20 valeurs.

is

La valeur de la propriété de l'opérande est comparée à une valeur unique.

Lors de l'utilisation de is, une seule valeur peut être spécifiée.

values

Une chaîne, ou un tableau de chaînes, à comparer à la propriété operand pour déterminer si le journal est acheminé ou non.

Lorsque le site is operator est utilisé, le site values doit comprendre une seule chaîne de caractères.

Lorsque in operator est utilisé, values peut inclure plusieurs chaînes dans un tableau.

--managed-by

Identifie la manière dont un itinéraire est géré.

Un itinéraire peut être géré localement dans le compte où il est créé en définissant la valeur par défaut account ou peut être géré par le compte d'entreprise en définissant la valeur enterprise.

Les valeurs valides sont : enterprise, ou account.

La valeur par défaut est "account".

Vous ne pouvez pas modifier cette valeur après la création de l'itinéraire.

--output FORMAT

Si JSON est spécifié, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée sous forme de tableau.

help | --help | -h

Répertorie les options disponibles pour la commande.

ibmcloud logs-router route update

Utilisez cette commande pour mettre à jour un itinéraire qui définit comment les données sont acheminées vers les cibles IBM Cloud Logs Routing d'un compte à partir d'une ou de plusieurs régions.

Toute valeur spécifiée qui est différente de celle qui a été créée à l'origine de l'itinéraire est mise à jour avec la valeur spécifiée dans la commande. Toute configuration précédemment déployée et non incluse dans la demande de mise à jour est supprimée.

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

Options de commande

--route ROUTE

ID ou nom de la route.

L'ID est un UUID v4 qui identifie l'itinéraire de manière unique.

La longueur maximale de l'ID est de 1028 caractères. La longueur minimale de l'identifiant est de 24 caractères.

--name NAME

Le nouveau nom à donner à l'itinéraire (facultatif).

N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

--rules RULES | @RULES-FILE

Règles de routage qui seront évaluées dans l'ordre dans lequel elles sont configurées.

Doit être défini comme une chaîne JSON entre guillemets simples ou un chemin d'accès à un fichier JSON.

La longueur maximale est de 10 règles. La longueur minimale est de 1 règle.

Conservez votre configuration actuelle en plus des modifications que vous devez apporter. Toute configuration de règle existante qui n'est pas incluse dans la mise à jour est supprimée.

Par exemple, voir l'exemple d'une définition de règle au format JSON ou utiliser @filepath pour transmettre le json :

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

Vous pouvez formater le fichier JSON comme suit pour acheminer toutes les données vers les cibles configurées dans la règle :

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

La définition de la règle peut éventuellement inclure des filtres d'inclusion. Vous pouvez formater le fichier JSON comme suit :

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

Action définit si IBM Cloud Logs Routing inclut ou exclut les journaux sur l'itinéraire. Deux actions sont prises en charge : send et drop. Si elle n'est pas spécifiée, l'action par défaut est d'envoyer les journaux.

send
Les journaux sont envoyés, en fonction de la règle de routage, sur l'itinéraire défini.
drop
Les journaux sont exclus, en fonction de la règle de routage, lorsqu'ils sont envoyés sur l'itinéraire défini.
targets

Les cibles définissent les destinations IBM Cloud Logs où les journaux sont acheminés. Il s'agit d'une liste d'ID de cibles séparées par des virgules.

inclusion_filters

Les filtres d'inclusion définissent les données qui sont acheminées.

Vous pouvez configurer une liste de filtres séparés par des virgules.

Un filtre est défini par un opérande, un opérateur et des valeurs.

Vous pouvez définir un maximum de 7 filtres par règle.

operand

Operand est le nom de la propriété sur laquelle operator est exécuté.

Les opérandes valides sont les suivants : location.

operator

Deux opérateurs sont pris en charge : in et is.

in

La valeur de la propriété de l'opérande est comparée à une liste de valeurs.

Vous pouvez définir jusqu'à 20 valeurs.

is

La valeur de la propriété de l'opérande est comparée à une valeur unique.

Lors de l'utilisation de is, une seule valeur peut être spécifiée.

values

Une chaîne, ou un tableau de chaînes, à comparer à la propriété operand pour déterminer si le journal est acheminé ou non.

Lorsque le site is operator est utilisé, le site values doit comprendre une seule chaîne de caractères.

Lorsque in operator est utilisé, values peut inclure plusieurs chaînes dans un tableau.

--output FORMAT

Si JSON est spécifié, la sortie est renvoyée au format JSON. Si JSON n'est pas spécifié, la sortie est renvoyée sous forme de tableau.

help | --help | -h

Répertorie les options disponibles pour la commande.

ibmcloud logs-router route delete

Cette commande permet de supprimer un itinéraire IBM Cloud Logs Routing.

ibmcloud logs-router route delete --route ROUTE

Options de commande

--route ROUTE
L'ID ou le nom de l'itinéraire à supprimer.
--force ou --f
Supprime l'itinéraire sans fournir à l'utilisateur une invite supplémentaire.
help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router route get

Cette commande permet d'obtenir des informations sur la configuration d'un itinéraire IBM Cloud Logs Routing.

ibmcloud logs-router route get --route ROUTE

Options de commande

--route ROUTE
ID ou nom de la route.
help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router route list

Cette commande permet de répertorier tous les itinéraires configurés pour IBM Cloud Logs Routing dans le compte.

ibmcloud logs-router route list

Options de commande

help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router target create

Cette commande permet de créer une cible à utiliser pour configurer une destination pour les mesures de la plate-forme. Vous pouvez envoyer les journaux de votre plate-forme de toutes les régions à une seule cible, à plusieurs cibles ou à des cibles multiples. Il n'est pas nécessaire d'avoir une cible par région. Vous pouvez définir jusqu'à 16 cibles par compte.

Les cibles doivent être des instances IBM Cloud Logs.

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

Options de commande

--region REGION

Nom de la région, par exemple, us-south ou eu-gb. Si elle n'est pas spécifiée, c'est la région connectée ou ciblée qui est utilisée. Facultatif.

--name NAME

Nom à attribuer à la cible.

N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

--destination-crn DESTINATION-CRN

Le CRN de l'instance de service ou de la ressource qui doit recevoir les journaux envoyés par IBM Cloud Logs Routing. Assurez-vous d'avoir une autorisation de service entre IBM Cloud Logs Routing et votre ressource IBM Cloud. Pour plus d'informations, voir Gérer les autorisations pour accorder l'accès entre les services...

[--managed-by MANAGED-BY] Facultatif. Identifie la personne qui gère cette cible. Facultatif au moment de la création. Si elle est définie sur "entreprise", la cible devient gérée par l'entreprise et ne peut être modifiée que par des identités autorisées à effectuer des actions au niveau de l'entreprise. S'il est omis ou si sa valeur est "account", la cible est gérée par le compte enfant. Cette valeur est immuable après la création. Les valeurs autorisées sont : entreprise, compte.

help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router target update

Cette commande permet de mettre à jour une cible à utiliser pour configurer une destination pour les mesures de la plate-forme.

Les cibles doivent être des instances IBM Cloud Logs.

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

Options de commande

--target TARGET ID ou nom de la cible.

--name NAME

Le nouveau nom à donner à la cible.

N'incluez aucune information d'identification personnelle (PII) dans les noms de ressources.

--destination-crn DESTINATION_CRN

Le CRN de l'instance de service ou de la ressource qui doit recevoir les journaux envoyés par IBM Cloud Logs Routing. Assurez-vous d'avoir une autorisation de service entre IBM Cloud Logs Routing et votre ressource IBM Cloud. Pour plus d'informations, voir Gérer les autorisations pour accorder l'accès entre les services...

help | --help | -h

Répertorie les options disponibles pour la commande.

ibmcloud logs-router target delete

Cette commande permet de supprimer une cible.

ibmcloud logs-router target delete --target TARGET

Options de commande

--target TARGET
ID ou nom de la cible.
--force | -f
Supprime la cible sans fournir à l'utilisateur d'invite supplémentaire.
help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router target get

Cette commande permet d'obtenir des informations sur une cible IBM Cloud Logs Routing.

ibmcloud logs-router target get --target TARGET

Options de commande

--target TARGET
ID ou nom de la cible.
help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router target list

Cette commande permet de dresser la liste de toutes les cibles configurées pour IBM Cloud Logs Routing.

ibmcloud logs-router target list

Options de commande

help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router setting get

Cette commande permet d'obtenir les paramètres de configuration du niveau de compte IBM Cloud Logs Routing.

ibmcloud logs-router setting get

Options de commande

help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router setting update

Utilisez cette commande pour modifier les paramètres actuels tels que les cibles par défaut, les régions cibles autorisées, les régions de métadonnées primaires et secondaires dans IBM Cloud Logs Routing. Toute valeur différente de celle qui a été créée à l'origine est mise à jour en fonction de la valeur spécifiée dans la commande. Si aucune option n'est spécifiée, les paramètres actuels sont renvoyés.

Avant de désactiver les noeuds finaux publics en définissant --private-api-endpoint-only TRUE, assurez-vous que votre compte a accès au noeud final privé. Pour ce faire, exécutez la commande ibmcloud account show. Si VRF Enabled est true et Service Endpoint Enabled est true, vous avez alors accès au nœud final privé. Si vous n'avez pas accès au point de terminaison privé, vous ne pouvez pas activer le point de terminaison public. L'accès au point d'accès privé est nécessaire pour activer le point d'accès public.

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]

Options de commande

--api-version
Version de l'API pour le service IBM Cloud Logs Routing dans le compte IBM Cloud. Les valeurs valables sont 1 et 3. La valeur par défaut est 1. Vous pouvez passer de 1 à 3 pour migrer votre configuration de service uniquement si vous avez créé des cibles et des locataires valides sur V1. Notez qu'une fois cette mise à jour effectuée, il n'est pas possible de revenir à la version 1. Pour plus d'informations, voir https://ibm.biz/lr-v3migration.
--backup-metadata-region
Région de sauvegarde utilisée pour sauvegarder les métadonnées de IBM Cloud Logs Routing. La longueur maximale est de 256 caractères. La longueur minimale est de 3 caractères.
--default-targets
Les cibles qui reçoivent des journaux qui ne sont pas explicitement gérés dans les règles de routage du compte IBM Cloud Logs Routing. Vous pouvez définir jusqu'à 2 cibles. Le nombre minimum de cibles est de 0.
--permitted-target-regions
Liste séparée par des virgules des régions prises en charge par IBM Cloud Logs Routing dans lesquelles les utilisateurs peuvent créer des cibles dans le compte. Pour plus d'informations, voir https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations. La longueur maximale est de 16 régions. La longueur minimale est de 0 région.
--primary-metadata-region
Région primaire utilisée pour sauvegarder les métadonnées de IBM Cloud Logs Routing. La longueur maximale est de 256 caractères. La longueur minimale est de 3 caractères.
--private-api-endpoint-only
Connectivité des points d'extrémité prise en charge. Définissez cette valeur sur "false" pour accéder à l'API via le réseau public. Définissez cette valeur sur "true" pour accéder à l'API via le réseau privé uniquement.
help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router migrate complete

Utilisez cette commande pour terminer les journaux de migration de la version 1 vers la version 3. L'état de la migration doit être PENDING_COMPLETION pour que cette commande puisse être utilisée.

ibmcloud logs-router migrate complete

Options de commande

help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router migrate generate

Cette commande permet de lancer la migration asynchrone des logs de routage de la version 1 à la version 3. L'état de la migration doit être AVANT pour utiliser cette commande.

ibmcloud logs-router migrate generate

Options de commande

help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router migrate delete

Cette commande permet de supprimer tous les itinéraires et cibles de la version 3 du routage et de réinitialiser l'état de la migration à AVANT. Uniquement autorisé lorsque l'état est PENDING_COMPLETION ou BEFORE.

ibmcloud logs-router migrate delete

Options de commande

--force|-f`
Supprime l'opération sans confirmation.
help | --help | -h
Répertorie les options disponibles pour la commande.

ibmcloud logs-router migrate status

Utilisez cette commande pour récupérer les journaux d'état de la migration de routage et les informations sur la version. Les états possibles sont les suivants : COMPLETE, BEFORE, IN_PROGRESS et PENDING_COMPLETION.

ibmcloud logs-router migrate status

Options de commande

help | --help | -h
Répertorie les options disponibles pour la commande.