Descripción general de la CLI de OpenThread

Ver código fuente en GitHub

La CLI de OpenThread expone las API de configuración y administración desde una interfaz de línea de comandos. Usa la CLI de OT para crear un entorno de desarrollo de OpenThread o úsala como una herramienta con código de aplicación adicional. Por ejemplo, las secuencias de comandos de prueba de OpenThread usan la CLI para ejecutar casos de prueba.

Comienza ahora

Completa nuestro Codelab de simulación con Docker y revisa la referencia del comando de la CLI.

Ir al codelab de simulación Ir a la referencia de comandos de la CLI

Usar la CLI de PO

Puede usar la CLI de OT con un router de borde de OpenThread (OTBR) y dispositivos Thread. Los comandos de la CLI varían según el tipo de dispositivo y las marcas de compilación.

TCBR

Para usar la CLI de PO con OTBR, ingresa el siguiente prefijo antes de cada comando:

sudo ot-ctl

Dispositivos Thread

Para usar los comandos de la CLI en un dispositivo Thread, consulta la documentación de la plataforma, el codelab o la guía. Para muchos ejemplos, puedes comenzar a escribir comandos sin un prefijo:

state
router
Done

A continuación, le presentamos algunos recursos que lo ayudarán a comenzar:

Caracteres especiales

El carácter de espacio en blanco (' ') se usa para delimitar el nombre del comando y los diferentes argumentos, junto con la pestaña ('\t') y los caracteres de línea nuevos ('\r', '\n').

Algunos argumentos pueden incluir espacios, como el nombre de la red Thread. Para enviar argumentos que incluyan espacios, usa el carácter de barra invertida ('\') a fin de escapar los separadores o la propia barra inversa:

networkname Test\ Network
Done
networkname
Test Network
Done

Asignaciones de argumentos

La CLI de PO usa argumentos predefinidos que corresponden a los valores de configuración de la API. Estas asignaciones se pueden pasar con comandos de la CLI y también se pueden mostrar en la consola de la CLI para varios comandos de datos de red, por ejemplo, netdata show.

otBorderRouterConfig.

Algunos comandos, por ejemplo, prefix add, requieren valores otBorderRouterConfig. Para configurar los miembros de otBorderRouterConfig desde la línea de comandos, la CLI de PO analiza un argumento de letra asignado para cada miembro. Por ejemplo, la combinación de argumentos paros establece los miembros mPreferred, mSlaac, mDefaultRoute, mOnMesh y mStable, de forma consecutiva.

Sintaxis

En el siguiente ejemplo, prefix es obligatorio, y los argumentos otBorderRouterConfig son opcionales, se asignan como p, a, d, c, r, o, s, n y D:

prefix add prefix [padcrosnD]

Uso

Para usar la asignación de argumentos, no ingreses espacios entre las letras:

prefix add 2001:dead:beef:cafe::/64 paros

otRoutePreference

Para configurar otRoutePreference, usa high, med o, también, low en los comandos de la CLI de PO.

Sintaxis

prefix add prefix [padcrosnD] [high|med|low]

Uso

A continuación, se muestra un ejemplo del uso de los parámetros otBorderRouterConfig y otRoutePreference asignados:

prefix add 2001:dead:beef:cafe::/64 paros med
Done

Configuración de ruta externa

Para los valores de otExternalRouteConfig, s se asigna a mStable y n se asigna a mNat64.

Sintaxis

publish route prefix [sn]

Uso

route add 2001:dead:beef:cafe::/64 s
Done

Valores de retorno

La mayoría de los comandos muestran el valor solicitado, seguido de Done:

br onlinkprefix
fd41:2650:a6f5:0::/64
Done

Otros comandos que incluyen datos de red pueden mostrar asignaciones de argumentos para registros de prefijos, rutas y servicios. Para obtener más información, consulta Display and Manage Network Data with OT CLI.