Panoramica dell'interfaccia a riga di comando OpenThread

Visualizza il codice sorgente su GitHub

L'interfaccia a riga di comando OpenThread espone le API di configurazione e gestione da un a interfaccia a riga di comando. Usa OT CLI per creare uno sviluppo OpenThread o come strumento con il codice dell'applicazione aggiuntivo. Ad esempio: OpenThread Gli script di test utilizzano l'interfaccia a riga di comando per eseguire scenari di test.

Inizia

Completa il nostro codelab sulla simulazione con Docker e rivedi il riferimento ai comandi dell'interfaccia a riga di comando.

Vai al codelab sulla simulazione Vai alla guida di riferimento dei comandi dell'interfaccia a riga di comando

Utilizza OT CLI

Puoi utilizzare OT CLI con il router di confine OpenThread (OTBR) e i dispositivi Thread. CLI variano in base al tipo di dispositivo e ai flag della build.

PTB

Per utilizzare OT CLI con OTBR, inserisci quanto segue prima di ogni comando:

sudo ot-ctl

Dispositivi Thread

Per utilizzare i comandi dell'interfaccia a riga di comando su un dispositivo Thread, consulta la documentazione della piattaforma. codelab o una guida. Per molti esempi, puoi iniziare a digitare comandi senza prefisso:

state
router
Done

Di seguito sono riportate alcune risorse utili per iniziare:

Caratteri speciali

Lo spazio vuoto (' ') viene utilizzato per delimitare il nome del comando e argomenti diversi, insieme a caratteri di tabulazione ('\t') e di nuova riga ('\r', '\n').

Alcuni argomenti potrebbero includere spazi, ad esempio il nome di una rete Thread. A inviare argomenti che includono spazi, utilizza il carattere della barra rovesciata ('\') per separatori di escape o la barra rovesciata stessa:

networkname Test\ Network
Done
networkname
Test Network
Done

Mappature di argomenti

OT CLI utilizza argomenti predefiniti che corrispondono ai valori di configurazione dell'API. Questi le mappature possono essere passate con i comandi dell'interfaccia a riga di comando e potrebbero anche tornare all'interfaccia a riga di comando per vari comandi di Dati di rete, ad esempio netdata show.

otBorderRouterConfig

Alcuni comandi, ad esempio prefix add, richiedono otBorderRouterConfig e i relativi valori. Per impostare otBorderRouterConfig membri dalla riga di comando, OT CLI analizza un argomento lettera mappato per ogni membro. Ad esempio, l'argomento la combinazione paros imposta mPreferred, mSlaac, mDefaultRoute, mOnMesh, e mStable consecutivamente.

Sintassi

Nell'esempio seguente, prefix è obbligatorio e otBorderRouterConfig argomenti sono facoltativi, mappati come p, a, d, c, r, o, s, n e D:

prefix add prefix [padcrosnD]

Utilizzo

Per utilizzare le mappature di argomenti, non inserire spazi tra le lettere:

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

otRoutePreference

Per impostare otRoutePreference: usa high, med o low nei comandi OT CLI.

Sintassi

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

Utilizzo

Ecco un esempio di utilizzo di otBorderRouterConfig e otRoutePreference mappati parametri:

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

otExternalRouteConfig

Per otExternalRouteConfig di valori, s viene mappato a mStable e n a mNat64.

Sintassi

publish route prefix [sn]

Utilizzo

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

Valori restituiti

La maggior parte dei comandi restituisce il valore richiesto, seguito da Done:

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

Altri comandi che includono dati di rete potrebbero restituire mappature di argomenti per prefisso, route e record di servizio. Per ulteriori informazioni, consulta Visualizza e gestisci i dati di rete con OT CLI.