CLI de IBM Cloud Logs Routing

La interfaz de línea de mandatos (CLI) de IBM Cloud® proporciona prestaciones adicionales para las ofertas de servicio. Esta información describe cómo puede utilizar la CLI para definir y gestionar el servicio IBM Cloud Logs Routing mediante la CLI.

Antes de empezar

Complete los pasossiguientes:

Instale la CLI de IBM Cloud.
Instale y configure la CLI IBM Cloud Logs Routing.

Se le notifica en la línea de mandatos cuando las actualizaciones de la CLI de IBM Cloud y los plug-ins están disponibles. Asegúrese de mantener su CLI actualizada para poder utilizar los comandos más actuales. Puede ver la versión actual de todos los plugins instalados con el mandato ibmcloud plugin list.

ibmcloud logs-router route crear

Utilice este comando para crear una ruta que defina cómo se enrutan los datos a los destinos IBM Cloud Logs Routing de una cuenta desde una o varias regiones. Una ruta puede ser gestionada en la cuenta donde se crea o puede ser gestionada por la cuenta padre de la empresa.

Los objetivos deben ser instancias de IBM Cloud Logs.

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

Opciones de comando

--name ROUTE_NAME

El nombre que se le dará a la ruta.

La longitud máxima es de 1000 caracteres. La longitud mínima es de 1 carácter.

El nombre no puede incluir caracteres especiales distintos de (space) - . _ :.

No incluya información de identificación personal en ningún nombre de recurso.

--rules RULES | @RULES-FILE

Reglas de enrutamiento que se evaluarán en el orden en que estén configuradas.

Debe ser una cadena JSON entre comillas simples o una ruta a un archivo JSON.

La longitud máxima es de 10 reglas. La longitud mínima es de 1 regla.

Por ejemplo, puede establecer una cadena JSON de la siguiente manera o utilizar @filepath para pasar el json:

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

Puede formatear el archivo JSON de la siguiente manera para enrutar todos los datos a los destinos configurados en la regla:

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

La definición de la regla puede incluir opcionalmente filtros de inclusión. Puede formatear el archivo JSON de la siguiente manera:

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

Donde:

action

La acción define si IBM Cloud Logs Routing incluye o excluye registros en la ruta. Se admiten dos acciones: send y drop. Si no se especifica, la acción por defecto es enviar los registros.

send: Los registros se envían, en función de la regla de enrutamiento, por la ruta definida.
drop: Los registros se excluyen, en función de la regla de enrutamiento, cuando se envían registros en la ruta definida.

targets

Los objetivos definen los destinos de IBM Cloud Logs a los que se dirigen los registros. Es una lista de ID de destino separada por comas.

inclusion_filters

Los filtros de inclusión definen qué datos se enrutan.

Puede configurar una lista de filtros separada por comas.

Un filtro se define mediante un operando, un operador y valores.

Puede definir un máximo de 7 filtros por regla.

operand

Operando es el nombre de la propiedad sobre la que se ejecuta operator.

Los operandos válidos son: location.

operator

Se admiten dos operadores: in y is.

in

El valor de la propiedad del operando se compara con una lista de valores.

Puede definir hasta 20 valores.

is

El valor de la propiedad del operando se compara con un único valor.

Cuando se utiliza is, sólo se puede especificar 1 valor.

values

Una cadena, o una matriz de cadenas, que se comparará con la propiedad operand para determinar si el registro está enrutado o no.

Cuando se utiliza is operator, values debe incluir una única cadena.

Cuando se utiliza in operator, values puede incluir varias cadenas en una matriz.

--managed-by

Identifica cómo se gestiona una ruta.

Una ruta puede ser gestionada localmente en la cuenta donde se crea estableciendo el valor por defecto account o puede ser gestionada por la cuenta de empresa estableciendo el valor enterprise.

Los valores válidos son: enterprise, o account.

El valor por defecto es "cuenta".

No es posible modificar este valor una vez creada la ruta.

--output FORMAT

Si se especifica JSON, la salida se devuelve en formato JSON. Si no se especifica JSON, la salida se devuelve en formato tabular.

help | --help | -h

Listar las opciones disponibles para el mandato.

ibmcloud logs-router route update

Utilice este comando para actualizar una ruta que define cómo se enrutan los datos a los destinos IBM Cloud Logs Routing de una cuenta desde una o varias regiones.

Cualquier valor especificado que sea diferente de cuando se creó originalmente la ruta se actualiza al valor especificado en el comando. Se elimina cualquier configuración previamente desplegada y no incluida en la solicitud de actualización.

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

Opciones de comando

--route ROUTE

El ID o el nombre de la ruta.

El ID es un UUID de v4 que identifica la ruta de forma única.

La longitud máxima del ID es de 1028 caracteres. La longitud mínima del ID es de 24 caracteres.

--name NAME

El nuevo nombre que se dará a la ruta (opcional).

No incluya información de identificación personal en ningún nombre de recurso.

--rules RULES | @RULES-FILE

Reglas de enrutamiento que se evaluarán en el orden en que estén configuradas.

Debe ser una cadena JSON entre comillas simples o una ruta a un archivo JSON.

La longitud máxima es de 10 reglas. La longitud mínima es de 1 regla.

Conserve su configuración actual además de las modificaciones que deba realizar. Se elimina cualquier configuración de regla existente que no se incluya en la actualización.

Por ejemplo, vea el ejemplo de una definición de regla con formato JSON o utilice @filepath para pasar el json:

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

Puede formatear el archivo JSON de la siguiente manera para enrutar todos los datos a los destinos configurados en la regla:

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

La definición de la regla puede incluir opcionalmente filtros de inclusión. Puede formatear el archivo JSON de la siguiente manera:

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

action

La acción define si IBM Cloud Logs Routing incluye o excluye registros en la ruta. Se admiten dos acciones: send y drop. Si no se especifica, la acción por defecto es enviar los registros.

send: Los registros se envían, en función de la regla de enrutamiento, por la ruta definida.
drop: Los registros se excluyen, en función de la regla de enrutamiento, cuando se envían registros en la ruta definida.

targets

Los objetivos definen los destinos de IBM Cloud Logs a los que se dirigen los registros. Es una lista de ID de destino separada por comas.

inclusion_filters

Los filtros de inclusión definen qué datos se enrutan.

Puede configurar una lista de filtros separada por comas.

Un filtro se define mediante un operando, un operador y valores.

Puede definir un máximo de 7 filtros por regla.

operand

Operando es el nombre de la propiedad sobre la que se ejecuta operator.

Los operandos válidos son: location.

operator

Se admiten dos operadores: in y is.

in

El valor de la propiedad del operando se compara con una lista de valores.

Puede definir hasta 20 valores.

is

El valor de la propiedad del operando se compara con un único valor.

Cuando se utiliza is, sólo se puede especificar 1 valor.

values

Una cadena, o una matriz de cadenas, que se comparará con la propiedad operand para determinar si el registro está enrutado o no.

Cuando se utiliza is operator, values debe incluir una única cadena.

Cuando se utiliza in operator, values puede incluir varias cadenas en una matriz.

--output FORMAT

Si se especifica JSON, la salida se devuelve en formato JSON. Si no se especifica JSON, la salida se devuelve en formato tabular.

help | --help | -h

Listar las opciones disponibles para el mandato.

ibmcloud logs-router route delete

Utilice este comando para eliminar una ruta IBM Cloud Logs Routing.

ibmcloud logs-router route delete --route ROUTE

Opciones de comando

--route ROUTE: El ID o nombre de la ruta a eliminar.
--force o --f: Elimina la ruta sin proporcionar al usuario ninguna indicación adicional.
help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router route get

Utilice este comando para obtener información de configuración sobre una ruta IBM Cloud Logs Routing.

ibmcloud logs-router route get --route ROUTE

Opciones de comando

--route ROUTE: El ID o el nombre de la ruta.
help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router lista de rutas

Utilice este comando para listar todas las rutas configuradas para IBM Cloud Logs Routing en la cuenta.

ibmcloud logs-router route list

Opciones de comando

help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router target crear

Utilice este comando para crear un objetivo que se utilizará para configurar un destino para las métricas de la plataforma. Puede enviar los registros de su plataforma desde todas las regiones a un único objetivo, a distintos objetivos o a varios objetivos. No es necesario un objetivo por región. Puede definir hasta 16 objetivos por cuenta.

Los objetivos deben ser instancias de IBM Cloud Logs.

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

Opciones de comando

--region REGION

Nombre de la región, por ejemplo, us-south o eu-gb. Si no se especifica, se utiliza la región en la que se ha iniciado sesión, o a la que se dirige. Esto es opcional.

--name NAME

El nombre que debe darse al destino.

No incluya información de identificación personal en ningún nombre de recurso.

--destination-crn DESTINATION-CRN

El CRN de la instancia de servicio o recurso que recibirá los registros enviados por IBM Cloud Logs Routing. Asegúrese de que dispone de una autorización de servicio entre IBM Cloud Logs Routing y su recurso IBM Cloud. Para obtener más información, consulte Gestión de autorizaciones para conceder acceso entre servicios..

[--managed-by MANAGED-BY] Esto es opcional. Identifica quién gestiona este objetivo. Opcional en el momento de la creación. Si se establece en "empresa", el objetivo se convierte en gestionado por la empresa y sólo puede ser modificado por identidades autorizadas para las acciones de la empresa. Si se omite o se establece como "cuenta", el objetivo es gestionado por la cuenta secundaria. Este valor es inmutable después de la creación. Los valores permitidos son:empresa, cuenta.

help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router target update

Utilice este comando para actualizar un destino que se utilizará para configurar un destino para las métricas de la plataforma.

Los objetivos deben ser instancias de IBM Cloud Logs.

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

Opciones de comando

--target TARGET El ID o el nombre del destino.

--name NAME

El nuevo nombre que se dará al objetivo.

No incluya información de identificación personal en ningún nombre de recurso.

--destination-crn DESTINATION_CRN

help | --help | -h

Listar las opciones disponibles para el mandato.

ibmcloud logs-router target delete

Utilice este mandato para suprimir un destino.

ibmcloud logs-router target delete --target TARGET

Opciones de comando

--target TARGET: El ID o el nombre del destino.
--force | -f: Elimina el objetivo sin proporcionar al usuario ninguna indicación adicional.
help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router target get

Utilice este comando para obtener información sobre un objetivo IBM Cloud Logs Routing.

ibmcloud logs-router target get --target TARGET

Opciones de comando

--target TARGET: El ID o el nombre del destino.
help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router lista de objetivos

Utilice este comando para listar todos los objetivos configurados para IBM Cloud Logs Routing.

ibmcloud logs-router target list

Opciones de comando

help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router setting get

Utilice este comando para obtener los ajustes de las configuraciones de nivel de cuenta de IBM Cloud Logs Routing.

ibmcloud logs-router setting get

Opciones de comando

help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router setting update

Utilice este comando para modificar la configuración actual, como los destinos predeterminados, las regiones de destino permitidas y las regiones de metadatos primarias y secundarias en IBM Cloud Logs Routing. Cualquier valor que sea diferente del que tenía cuando se creó el objetivo se actualiza al valor especificado en el comando. Si no se especifica ninguna opción, se devuelve la configuración actual.

Antes de inhabilitar los puntos finales públicos estableciendo --private-api-endpoint-only TRUE, asegúrese de que la cuenta tenga acceso al punto final privado. Puede hacerlo ejecutando el mandato ibmcloud account show. Si VRF Enabled es true y Service Endpoint Enabled es true, tendrá acceso al punto final privado. Si no tiene acceso al punto final privado, no podrá activar el punto final público. Para habilitar el punto final público se requiere acceso al punto final privado.

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]

Opciones de comando

--api-version: Versión de la API para el servicio IBM Cloud Logs Routing en la cuenta IBM Cloud. Los valores válidos son 1 y 3. El valor predeterminado es 1. Puede actualizar de 1 a 3 para migrar la configuración de su servicio sólo si ha creado destinos y arrendatarios válidos en V1. Tenga en cuenta que una vez realizada esta actualización, no hay opción de volver a la versión 1. Para más información, consulte https://ibm.biz/lr-v3migration.
--backup-metadata-region: Región de copia de seguridad que se utiliza para realizar copias de seguridad de los metadatos de IBM Cloud Logs Routing. La longitud máxima es 256 caracteres. La longitud mínima es de 3 caracteres.
--default-targets: Objetivos que reciben registros no gestionados explícitamente en las reglas de enrutamiento de la cuenta IBM Cloud Logs Routing. Puede definir hasta 2 objetivos. El número mínimo de objetivos es 0.
--permitted-target-regions: Lista separada por comas de las regiones compatibles con IBM Cloud Logs Routing en las que los usuarios pueden crear objetivos en la cuenta. Para más información, consulte https://cloud.ibm.com/docs/logs-router?topic=logs-router-locations. La longitud máxima es de 16 regiones. La longitud mínima es 0 región.
--primary-metadata-region: Región primaria que se utiliza para realizar copias de seguridad de los metadatos de IBM Cloud Logs Routing. La longitud máxima es 256 caracteres. La longitud mínima es de 3 caracteres.
--private-api-endpoint-only: Conectividad de punto final admitida. Establezca este valor en "false" para acceder a la API a través de la red pública. Establezca este valor en "true" para acceder a la API sólo a través de la red privada.
help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router migrate complete

Utilice este comando para completar los registros de migración de la versión 1 a la versión 3. El estado de la migración debe ser PENDING_COMPLETION para poder utilizar este comando.

ibmcloud logs-router migrate complete

Opciones de comando

help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router migrate generate

Utilice este comando para iniciar la migración asíncrona del enrutamiento de registros de la versión 1 a la versión 3. El estado de migración debe ser ANTES para poder utilizar este comando.

ibmcloud logs-router migrate generate

Opciones de comando

help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router migrate delete

Utilice este comando para eliminar todos los registros de rutas y destinos de la versión 3 de enrutamiento y restablecer el estado de migración a ANTES. Sólo se permite cuando el estado es PENDIENTE_COMPLECIÓN o ANTES.

ibmcloud logs-router migrate delete

Opciones de comando

--force|-f`: Borra la operación sin confirmación.
help | --help | -h: Listar las opciones disponibles para el mandato.

ibmcloud logs-router migrate status

Utilice este comando para recuperar los registros de estado de migración de enrutamiento y la información de versión. Los estados posibles son: COMPLETO, ANTES, EN_PROCESO y PENDIENTE_COMPLETACIÓN.

ibmcloud logs-router migrate status

Opciones de comando

help | --help | -h: Listar las opciones disponibles para el mandato.