OpenThread CLI Reference

The OpenThread CLI exposes configuration and management APIs via a command line interface. This CLI may be used to play with OpenThread and may be used along side additional application code. The OpenThread test scripts use this CLI to execute test cases.

OpenThread Command List

channel
childtimeout
contextreusedelay
extaddr
extpanid
ipaddr
keysequence
leaderweight
masterkey
mode
netdataregister
networkidtimeout
networkname
panid
ping
prefix
releaserouterid
rloc16
route
routerupgradethreshold
start
state
stop
whitelist

OpenThread Command Details

channel

Get the IEEE 802.15.4 Channel value.

$ channel
11
Done

channel <channel>

Set the IEEE 802.15.4 Channel value.

$ channel 11
Done

childtimeout

Get the Thread Child Timeout value.

$ childtimeout
300
Done

childtimeout <timeout>

Set the Thread Child Timeout value.

$ childtimeout 300
Done

contextreusedelay

Get the CONTEXT_ID_REUSE_DELAY value.

$ contextreusedelay
11
Done

contextreusedelay <delay>

Set the CONTEXT_ID_REUSE_DELAY value.

$ contextreusedelay 11
Done

extaddr

Get the IEEE 802.15.4 Extended Address.

$ extaddr
0xdead00beef00cafe
Done

extpanid

Get the Thread Extended PAN ID value.

$ extpanid
0xdead00beef00cafe
Done

extpanid <extpanid>

Set the Thread Extended PAN ID value.

$ extpanid dead00beef00cafe
Done

ipaddr

List all IPv6 addresses assigned to the Thread interface.

$ ipaddr
fdde:ad00:beef:0:0:ff:fe00:0
fe80:0:0:0:0:ff:fe00:0
fdde:ad00:beef:0:558:f56b:d688:799
fe80:0:0:0:f3d9:2a82:c8d8:fe43
Done

ipaddr add <ipaddr>

Add an IPv6 address to the Thread interface.

$ ipaddr add 2001::dead:beef:cafe
Done

ipaddr del <ipaddr>

Add an IPv6 address to the Thread interface.

$ ipaddr del 2001::dead:beef:cafe
Done

keysequence

Get the Thread Key Sequence.

$ keysequence
10
Done

keysequence <keysequence>

Set the Thread Key Sequence.

$ keysequence 10
Done

leaderweight

Get the Thread Leader Weight.

$ leaderweight
128
Done

leaderweight <weight>

Set the Thread Leader Weight.

$ leaderweight 128
Done

masterkey

Get the Thread Master Key value.

$ masterkey
00112233445566778899aabbccddeeff
Done

masterkey <key>

Set the Thread Master Key value.

$ masterkey 00112233445566778899aabbccddeeff
Done

mode

Get the Thread Device Mode value.

r: rx-on-when-idle
s: Secure IEEE 802.15.4 Data Requests
d: Full Function Device
n: Full Network Data

$ mode
rsdn
Done

mode [rsdn]

Set the Thread Device Mode value.

r: rx-on-when-idle
s: Secure IEEE 802.15.4 Data Requests
d: Full Function Device
n: Full Network Data

$ mode rsdn
Done

netdataregister

$ netdataregister
Done

networkidtimeout

Get the NETWORK_ID_TIMEOUT parameter used in the Router role.

$ networkidtimeout
120
Done

networkidtimeout <timeout>

Set the NETWORK_ID_TIMEOUT parameter used in the Router role.

$ networkidtimeout 120
Done

networkname

Get the Thread Network Name.

$ networkname
OpenThread
Done

networkname <name>

Set the Thread Network Name.

$ networkname OpenThread
Done

panid

Get the IEEE 802.15.4 PAN ID value.

$ panid
0xdead
Done

panid <panid>

Set the IEEE 802.15.4 PAN ID value.

$ panid 0xdead
Done

ping <ipaddr> [size]

Send an ICMPv6 Echo Request.

$ ping fdde:ad00:beef:0:558:f56b:d688:799
16 bytes from fdde:ad00:beef:0:558:f56b:d688:799: icmp_seq=1 hlim=64

prefix add <prefix> [pvdcsr] [prf]

Add a valid prefix to the Network Data.

p: Stateless IPv6 Address Autoconfiguration Preferred flag
v: Stateless IPv6 Address Autoconfiguration Valid flag
d: DHCPv6 IPv6 Address Configuration flag
c: DHCPv6 Other Configuration flag
s: Stable flag
r: Default Route flag
prf: Default router preference. An integer in the range [-1, 1]

$ prefix add 2001:dead:beef:cafe::/64 pvsr 0
Done

prefix remove <prefix>

Invalidate a prefix in the network data.

$ prefix remove 2001:dead:beef:cafe::/64
Done

releaserouterid <routerid>

Release a Router ID that has been allocated by the device in the Leader role.

$ releaserouterid 16
Done

rloc16

Get the Thread RLOC16 value.

$ rloc16
0xdead
Done

route add <prefix> [s] [prf]

Add a valid prefix to the Network Data.

s: Stable flag
r: Default Route flag
prf: Default router preference. An integer in the range [-1, 1]

$ route add 2001:dead:beef:cafe::/64 pvsr 0
Done

route remove <prefix>

Invalidate a prefix in the network data.

$ route remove 2001:dead:beef:cafe::/64
Done

routerupgradethreshold

Get the ROUTER_UPGRADE_THRESHOLD value.

$ routerupgradethreshold
16
Done

routerupgradethreshold <threshold>

Set the ROUTER_UPGRADE_THRESHOLD value.

$ routerupgradethreshold 16
Done

start

Enable OpenThread.

$ start
Done

stop

Disable OpenThread.

$ stop
Done

whitelist add <extaddr>

Add an IEEE 802.15.4 Extended Address to the whitelist.

$ whitelist add dead00beef00cafe
Done

whitelist clear

Clear all entries from the whitelist.

$ whitelist clear
Done

whitelist disable

Disable MAC whitelist filtering.

$ whitelist disable
Done

whitelist enable

Enable MAC whitelist filtering.

$ whitelist enable
Done

whitelist remove <extaddr>