Referencia de CLI de Event Streams

Si desea información sobre cómo instalar la CLI para Event Streams, consulte Cómo empezar con la CLI de Event Streams.

Registro de cambios

Registro de cambios para el Event Streams CLI plug-in
Versión Fecha del release Cambios
v1.0 12 mayo de 2019
  • Release inicial de la CLI de Event Streams.
v1.0.1 27 mayo de 2019 -Mensaje de error mejorado al ejecutar el mandato sin init.
-Lista de instancias clasificadas durante init.
-Actualización de conversión.
v2.0 21 de agosto de 2019

-init: se ha eliminado el requisito de clave de servicio.

  • Se ha añadido el mandato de supresión de grupo. Traducciones actualizadas del texto de ayuda.
v2.1 24 de junio de 2020

-init: se muestran los parámetros de suministro para la instancia de Enterprise.

  • Actualización de conversión.
v2.1.1 10 de julio de 2020
  • Sustituido whitelist por 'allowlist`.
  • Corregida la configuración de colores.
  • Actualización de la traducción.
v2.2.0 3 de agosto de 2020
  • Se ha añadido soporte para la función de duplicación.
v2.2.1 7 de agosto de 2020
  • init: Mejorada la visualización de la lista de IPs permitidas.
v2.3 9 de noviembre de 2020
  • Se ha añadido soporte para configurar la auditoría de mensajes en el tema.
    -init: se muestra la clave de cifrado si se especifica el parámetro kms_key_crn en el suministro.
v2.3.2 5 de mayo de 2022
  • Añadido soporte para Mac OS X M1/ARM.
  • init: Mostrar Object Storage cubo si el parámetro cos_bucket_crn se especifica en el aprovisionamiento.
v2.4.0 28 de febrero de 2023 -Se ha añadido la versión de Kafka a ibmcloud es cluster.
-Se ha actualizado Ir a 1.9.6.
v2.4.1 05 de diciembre de 2023 -Se han añadido los mandatos mirroring-active-topics y help.
v2.5.0 15 de diciembre de 2023 -Se han añadido mandatos schema-import.
v2.6.0 29 de agosto de 2024
  • Añadidos schemas, schema-create, schema, schema-update, schema-delete, schema-versions, schema-version-create, schema-version, schema-version-update, schema-version-delete, schema-compatibility-rule-create, schema-compatibility-rule, schema-compatibility-rule-update y schema-compatibility-rule-delete.
v2.6.1 01 Nov 2024
  • Corrección de vulnerabilidades.
v2.6.2 01 de febrero de 2025
  • Corrección de vulnerabilidades.
v2.7.0 25 de febrero de 2025
  • Se traducen los mensajes de error devueltos por el servidor kafka.
  • Fix broker-config configuración de impresión dos veces.
v2.7.1 01 de mayo de 2025
  • Corrección de vulnerabilidades.
v2.7.3 29 Abr 2026
  • Corrección de vulnerabilidades.
  • Cambios menores en el manejo de parámetros inválidos. Si no se especifica el parámetro opcional, es posible que se ignoren los parámetros no válidos en lugar de devolver un error.

ibmcloud es init

Inicialice el plug-in de Event Streams.

ibmcloud es init [-i|--instance-name INSTANCE_NAME] [-a|--api-url API_ENDPOINT_URL]

Requisitos previos: ninguno

Opciones de mandato:

--instance-name value, -i value (opcional)
Nombre de la instancia de Event Streams.
--api-url value, -a value (opcional)
URL de administración de Kafka de la instancia de Event Streams.

ibmcloud es broker

Mostrar los detalles de un corredor específico.

ibmcloud es broker [--broker] ID [--json]

Requisitos previos: ninguno

Opciones de mandato:

--broker value, -b value
El ID de intermediario se puede especificar precedido o no de un distintivo '--broker'.
--json (opcional)
Formato de salida en JSON.

ibmcloud es broker-config

Mostrar la configuración de un intermediario.

ibmcloud es broker-config [--broker] ID [--filter FILTER] [--verbose] [--json]

Requisitos previos: ninguno

Opciones de mandato:

--broker value, -b value
El ID de intermediario se puede especificar precedido o no de un distintivo '--broker'.
--filter value, -f value (opcional)
Filtre la lista de configuración utilizando comodines (*) o una expresión regular con delimitadores de barra inclinada (/).
--verbose, -v (opcional)
Mostrar información de configuración detallada.
--json (opcional)
Formato de salida en JSON.

ibmcloud es cluster

Muestra los detalles del cluster, incluyendo los detalles de todos los brokers y la versión de Kafka.

ibmcloud es cluster [--json]

Requisitos previos: ninguno

Opciones de mandato:

--json (opcional)
Formato de salida en JSON.

ibmcloud es topic

Mostrar los detalles de un tema.

ibmcloud es topic [--name] TOPIC_NAME [--json]

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value
Nombre de tema.
--json (opcional)
Formato de salida de JSON.

ibmcloud es topic-create

Crear un tema nuevo.

ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value

Nombre de tema.

--partitions value, -p value

Establecer el número de particiones para el tema.

--config CLAVE=VALOR, -c CLAVE=VALOR(opcional)

Establecer una opción de configuración para el tema como par CLAVE=VALOR.

Puede especificar varias opciones --config. Cada opción '--config' puede especificar una lista de asignaciones delimitada por puntos y comas. La lista siguiente muestra claves de configuración válidas:

  • cleanup.policy
  • retention.ms
  • retention.bytes
  • segment.bytes
  • segment.ms
  • segment.index.bytes

ibmcloud es topic-delete

Suprimir un tema.

ibmcloud es topic-delete [--name] TOPIC_NAME [--force]

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value
Nombre de tema.
--force, -f (opcional)
Suprimir sin confirmación.

ibmcloud es topic-delete-records

Suprimir registros de un tema para un desplazamiento determinado.

ibmcloud es topic-delete-records [--name] TOPIC_NAME [--partition-offset PARTITION:OFFSET[;PARTITION:OFFSET]* ]* [--force]

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value
Nombre de tema.
--partition-offset PARTICIÓN:DESPLAZAMIENTO, -p PARTICIÓN:DESPLAZAMIENTO
La partición y el desplazamiento para suprimir registros de un formato PARTICIÓN:DESPLAZAMIENTO.
Puede especificar varias opciones --partition-offset o puede especificar varios pares PARTICIÓN:DESPLAZAMIENTO con delimitadores de punto y coma entrecomillados: 'PARTICIÓN1:DESPLAZAMIENTO1;DESPLAZAMIENTO2:DESPLAZAMIENTO2;PARTICIÓN3:DESPLAZAMIENTO3'.
--force, -f (opcional)
Suprimir registros sin confirmación.

ibmcloud es topic-partitions-set

Establecer las particiones para un tema.

ibmcloud es topic-partitions-set [--name] TOPIC_NAME --partitions PARTITIONS

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value
Nombre de tema.
--partitions value, -p value
Establecer el número de particiones para el tema.

ibmcloud es topic-update

Actualizar la configuración para un tema.

ibmcloud es topic-update [--name] TOPIC_NAME --config KEY[=VALUE][;KEY[=VALUE]]* [--default]

Requisitos previos: ninguno

Opciones de mandato:

--name value, -n value

Nombre de tema.

--config KEY[=VALUE], -c KEY[=VALUE]

Establezca una opción de configuración para el tema como un par de KEY[=VALUE].

Si no se proporciona VALUE, se debe especificar el distintivo '--default' para indicar el restablecimiento del valor de configuración de nuevo al valor predeterminado. Se pueden especificar varias opciones en '--config'. Cada opción '--config' puede especificar una lista de asignaciones delimitada por puntos y comas. La lista siguiente muestra claves de configuración válidas:

  • cleanup.policy
  • retention.ms
  • retention.bytes
  • segment.bytes
  • segment.ms
  • segment.index.bytes
--default, -d (opcional)

Restablece cada parámetro de configuración especificado mediante '--config' a su valor por defecto.

ibmcloud es topics

Listar temas.

ibmcloud es topics [--filter FILTER] [--json]

Requisitos previos: ninguno

Opciones de mandato:

--filter value, -f value (opcional)
Nombre de tema.
--json (opcional)
El formato de salida es JSON. Se devuelven hasta 1000 temas.

ibmcloud es group

Mostrar detalles de un grupo de consumidores.

ibmcloud es group [--group] GROUP_ID [--json]

> Requisitos previos: ninguno

Opciones de mandato:

--group value, -g value
ID de grupo de consumidores.
--json (opcional)
El formato de salida es JSON.

ibmcloud es group-reset

Restablecer los desplazamientos para un grupo de consumidores.

ibmcloud es group-reset [--group] GROUP_ID [--topic TOPIC_NAME] [--all-topics] --mode MODE --value VALUE [--dry-run] [--execute] [--json]

Requisitos previos: ninguno

Opciones de mandato:

--group value, -g value
ID de grupo de consumidores
--topic value, -t value
Nombre de tema. Aplicar únicamente a este tema. Omitir si se ha proporcionado el distintivo '--all-topics'.
--all-topics, -a
Aplicar a todos los temas asignados al grupo. Omitir si se ha proporcionado el distintivo '--topic'.
--mode value, -m value
Uno de los valores siguientes: 'earliest' (primero), 'latest' (último) o 'datetime' (fecha y hora).
--value value, -v value
Valor para restablecer desplazamientos, basado en '--mode'. Se omite 'earliest' y 'latest'. 'datetime': utilice 'AAAA-MM-DDTHH:mm:SS.sss[± hh:mm|Z]'.
--dry-run (opcional)
Mostrar resultados y no implementar los cambios.
--execute (opcional)
Ejecutar los cambios en los desplazamientos.
--json (opcional)
El formato de salida es JSON.

ibmcloud es groups

Listar grupos de consumidores.

ibmcloud es groups [--filter FILTER] [--json]

Requisitos previos: ninguno

Opciones de mandato:

--filter value, -f value (opcional)
Opcional. Filtre la lista de grupos de consumidores utilizando comodines (*) o una expresión regular con delimitadores de barra inclinada (/).
--json (opcional)
El formato de salida es JSON. Se devuelve un máximo de 1000 grupos.

ibmcloud es group-delete

Suprimir un grupo de consumidores.

ibmcloud es group-delete [--group] GROUP_ID [--force]

Requisitos previos: ninguno

Opciones de mandato:

--group value, -g value
ID de grupo de consumidores
--force, -f (opcional)
Suprimir un grupo sin confirmación.

ibmcloud es mirroring-topic-selection

Listar la selección de temas de duplicación.

ibmcloud es mirroring-topic-selection [--json]

Requisitos previos: Duplicación habilitada en la instancia de Event Streams. Plugin Event Streams configurado para conectarse al clúster de destino de duplicación a través de ibmcloud es init.

Opciones de mandato:

--json (opcional)
El formato de salida es JSON.

ibmcloud es mirroring-topic-selection-set

Sustituir la selección de temas de duplicación.

ibmcloud es mirroring-topic-selection-set (--select pattern1,pattern2 | --none) [--force]

Requisitos previos: Duplicación habilitada en la instancia de Event Streams. Plugin Event Streams configurado para conectarse al clúster de destino de duplicación a través de ibmcloud es init.

Opciones de mandato:

--select value
Selección de temas que se deben duplicar como patrones de expresión regular separados por comas. Utilice '.*' para duplicar todos los temas.
--none
Borrar los temas seleccionados actualmente (inhabilitar la duplicación de temas).
--force
Opcional. Sustituir la selección de temas de duplicación sin confirmación.

ibmcloud es mirroring-active-topics

Obtener temas que se están duplicando activamente.

ibmcloud es mirroring-active-topics [--json]

Requisitos previos: Duplicación habilitada en la instancia de Event Streams. Plugin Event Streams configurado para conectarse al clúster de destino de duplicación a través de ibmcloud es init.

Opciones de mandato:

--json (opcional)
El formato de salida es JSON.

ayuda de ibmcloud es

Mostrar ayuda para un mandato o listar todos los mandatos.

ibmcloud es help [COMMAND]

Requisitos previos: ninguno

Opciones de mandato:

command (Opcional)
Mostrar la ayuda de un comando.

ibmcloud es schema-import

Importe un conjunto de esquemas en el registro desde un archivo zip.

ibmcloud es schema-import [--file] ZIP_FILE_PATH

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--file valor, -f valor
Vía de acceso de archivo zip.

ibmcloud es esquemas

Lista de esquemas en el registro.

ibmcloud es schemas [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-create

Crear un esquema.

ibmcloud es schema-create [--artifact-id SCHEMA_ID] --file PATH_TO_FILE [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
Opcional. ID del artefacto de esquema a crear. Si no se proporciona, se genera un ID.
--file valor
Ruta a un archivo que contiene la definición JSON del esquema que se va a crear.
--json
Opcional. El formato de salida es JSON.

esquema ibmcloud es

Mostrar información sobre un esquema.

ibmcloud es schema [--artifact-id] SCHEMA_ID [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del esquema.
--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-update

Cambiar el estado de un esquema.

ibmcloud es schema-update [--artifact-id] SCHEMA_ID --set ENABLED|DISABLED

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del esquema.
--set valor
Nuevo estado del esquema, debe ser 'HABILITADO' o 'DESHABILITADO'.

ibmcloud es schema-delete

Borrar un esquema.

ibmcloud es schema-delete [--artifact-id] SCHEMA_ID [--force]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas. El esquema debe estar en estado DESHABILITADO.

Opciones de mandato:

--artifact-id valor
ID del esquema.
--force
Opcional. Borrar el esquema sin confirmación.

ibmcloud es esquema-versiones

Mostrar versiones de un esquema.

ibmcloud es schema-versions [--artifact-id] SCHEMA_ID [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del esquema.
--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-version-create

Crear una nueva versión de un esquema.

ibmcloud es schema-version-create [--artifact-id] SCHEMA_ID --file PATH_TO_FILE [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del artefacto de esquema para el que se va a crear la nueva versión.
--file valor
Ruta a un archivo que contiene la definición JSON de la versión del esquema que se va a crear.
--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-version

Muestra información sobre la versión de un esquema.

ibmcloud es schema-version [--artifact-id SCHEMA_ID --version VERSION] [--global-id GLOBAL_ID] [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas. Utilice las banderas --artifact-id y --version, o la bandera --global-id.

Opciones de mandato:

--artifact-id valor
ID del artefacto de esquema.
--version valor
Versión que se mostrará.
--global-id valor
ID global de la versión del esquema a mostrar.
--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-version-update

Cambiar el estado de una versión del esquema.

ibmcloud es schema-version-update [--artifact-id] SCHEMA_ID --version VERSION --set ENABLED|DISABLED

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del artefacto de esquema.
--version valor
Versión a actualizar.
--set valor
Nuevo estado de la versión del esquema, debe ser 'HABILITADO' o 'DESHABILITADO'.
--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-version-delete

Borrar una versión de un esquema.

ibmcloud es schema-version-delete [--artifact-id] SCHEMA_ID --version VERSION [--force]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas. La versión del esquema debe estar en estado DESHABILITADO.

Opciones de mandato:

--artifact-id valor
ID del artefacto de esquema.
--version valor
Versión a eliminar.
--force
Opcional. Borrar la versión del esquema sin confirmación.

ibmcloud es schema-compatibility-rule-create

Crear regla de compatibilidad de esquemas.

ibmcloud es schema-compatibility-rule-create [--artifact-id] SCHEMA_ID --set RULE

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del esquema.
--set valor
El valor de la regla de compatibilidad. Los valores permitidos son "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" y "BACKWARD_TRANSITIVE".

ibmcloud es schema-compatibility-rule

Mostrar esquema o regla de compatibilidad global.

ibmcloud es es schema-compatibility-rule [ [--artifact-id] SCHEMA_ID | --global ]  [--json]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas. Utilice la bandera --artifact-id o --global.

Opciones de mandato:

--artifact-id valor
Opcional. ID del esquema.
--global
Opcional. Mostrar la regla de compatibilidad global.
--json
Opcional. El formato de salida es JSON.

ibmcloud es schema-compatibility-rule-update

Cambiar esquema o regla de compatibilidad global.

ibmcloud es schema-compatibility-rule-update [ [--artifact-id] SCHEMA_ID | --global ] --set RULE

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas. Utilice la bandera --artifact-id o --global.

Opciones de mandato:

--artifact-id valor
Opcional. ID del esquema.
--global
Opcional. Cambiar la regla de compatibilidad global.
--set valor
El valor de la regla de compatibilidad. Los valores permitidos son "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" y "BACKWARD_TRANSITIVE".

ibmcloud es schema-compatibility-rule-delete

Borrar regla de compatibilidad de esquemas.

ibmcloud es schema-compatibility-rule-delete [--artifact-id] SCHEMA_ID [--force]

Requisitos previos: esta operación sólo se permite en instancias de empresa, ya que solo el plan de empresa incluye un registro de esquema para utilizar y gestionar esquemas.

Opciones de mandato:

--artifact-id valor
ID del esquema.
--force
Opcional. Eliminar la regla de compatibilidad sin confirmación.