openthread/src/cli/README.md

OpenThread CLI Reference

The OpenThread CLI exposes configuration and management APIs via a command line interface. Use the CLI to play with OpenThread, which can also be used with additional application code. The OpenThread test scripts use the CLI to execute test cases.

OpenThread Command List

• autostart
• bufferinfo
• channel
• child
• childmax
• childtimeout
• coap
• coaps
• commissioner
• contextreusedelay
• counter
• dataset
• delaytimermin
• discover
• dns
• eidcache
• eui64
• extaddr
• extpanid
• factoryreset
• ifconfig
• ipaddr
• ipmaddr
• joiner
• joinerid
• joinerport
• keysequence
• leaderdata
• leaderpartitionid
• leaderweight
• linkquality
• logfilename
• macfilter
• masterkey
• mode
• neighbor
• netdataregister
• netdatashow
• networkdiagnostic
• networkidtimeout
• networkname
• networktime
• panid
• parent
• parentpriority
• ping
• pollperiod
• prefix
• promiscuous
• releaserouterid
• reset
• rloc16
• route
• router
• routerdowngradethreshold
• routerrole
• routerselectionjitter
• routerupgradethreshold
• scan
• singleton
• sntp
• state
• thread
• txpower
• version
• diag
• service

OpenThread Command Details

autostart enable

Automatically start Thread on initialization.

> autostart enable
Done

autostart disable

Don't automatically start Thread on initialization.

> autostart disable
Done

autostart

Show the status of automatically starting Thread on initialization.

> autostart
Disabled
Done

bufferinfo

Show the current message buffer information.

> bufferinfo
total: 40
free: 40
6lo send: 0 0
6lo reas: 0 0
ip6: 0 0
mpl: 0 0
mle: 0 0
arp: 0 0
coap: 0 0
Done

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

child list

List attached Child IDs.

> child list
1 2 3 6 7 8
Done

child table

Print table of attached children.

> child table
| ID  | RLOC16 | Timeout    | Age        | LQ In | C_VN |R|S|D|N| Extended MAC     |
+-----+--------+------------+------------+-------+------+-+-+-+-+------------------+
|   1 | 0xe001 |        240 |         44 |     3 |  237 |1|1|1|1| d28d7f875888fccb |
|   2 | 0xe002 |        240 |         27 |     3 |  237 |0|1|0|1| e2b3540590b0fd87 |
Done

child <id>

Print diagnostic information for an attached Thread Child. The id may be a Child ID or an RLOC16.

> child 1
Child ID: 1
Rloc: 9c01
Ext Addr: e2b3540590b0fd87
Mode: rsn
Net Data: 184
Timeout: 100
Age: 0
Link Quality In: 3
RSSI: -20
Done

childmax

Get the Thread maximum number of allowed children.

> childmax
5
Done

childmax <count>

Set the Thread maximum number of allowed children.

> childmax 2
Done

childtimeout

Get the Thread Child Timeout value.

> childtimeout
300
Done

childtimeout <timeout>

Set the Thread Child Timeout value.

> childtimeout 300
Done

coap start

Starts the application coap service.

> coap start
Coap service started: Done

coap stop

Stops the application coap service.

> coap stop
Coap service stopped: Done

coap resource [uri-path]

Sets the URI-Path for the test resource.

> coap resource test
Resource name is 'test': Done
> coap resource
Resource name is 'test': Done

coap <method> <address> <uri> [payload] [type]

• method: CoAP method to be used (GET/PUT/POST/DELETE).
• address: IP address of the CoAP server to query.
• uri: URI String of the resource on the CoAP server.
• payload: In case of PUT/POST/DELETE a payload can be encapsulated.
• type: Switch between confirmable ("con") and non-confirmable (default).

> coap get fdde:ad00:beef:0:dbaa:f1d0:8afb:30dc test
Sending coap message: Done
Received coap request from [fdde:ad00:beef:0:dbaa:f1d0:8afb:30dc]: GET
coap response sent successfully!
Received coap response with payload: 30
> coap put fdde:ad00:beef:0:dbaa:f1d0:8afb:30dc test non-con somePayload
Sending coap message: Done
Received coap request from [fdde:ad00:beef:0:dbaa:f1d0:8afb:30dc]: PUT with payload: 73 6f 6d 65 50 61 79 6c 6f 61 64
> coap put fdde:ad00:beef:0:dbaa:f1d0:8afb:30dc test con 123
Sending coap message: Done
Received coap request from [fdde:ad00:beef:0:dbaa:f1d0:8afb:30dc]: PUT with payload: 31 32 33
coap response sent successfully!
Received coap response

coaps start <checkPeerCert>

Starts the Application CoAP Secure Service.

• checkPeerCert: Peer Certificate Check can be disabled by typing false.

> coaps start false
Verify Peer Certificate: false. Coap Secure service started: Done
> coaps start
Verify Peer Certificate: true. Coap Secure service started: Done

coaps stop

Stops the Application CoAP Secure Service.

> coaps stop
Coap Secure service stopped:  Done

coaps set psk <preSharedKey> <keyIdentity>

Set a pre-shared key with his identifier and the ciphersuite "DTLS_PSK_WITH_AES_128_CCM_8" for the dtls session.

• preSharedKey: The pre-shared key (PSK) for dtls session.
• keyIdentity: The identifier for the PSK.

> coaps set psk myPreSharedSecret myIdentifier
Coap Secure set PSK: Done

coaps set x509

Set X.509 Certificate with his private key, which is saved in src/cli/x509_cert_key.hpp.

> coaps set x509
Coap Secure set own .X509 certificate: Done

coaps connect <serverAddress> [port]

Open a dtls session to a CoAP Secure Server.

• serverAddress: IPv6 address of Server

> coaps connect 2001:1234::321
Coap Secure connect: Done
CoAP Secure connected!

coaps disconnect

Terminate the dtls session to the Server.

> coaps disconnect
CoAP Secure not connected or disconnected.
Done

coaps <method> <address> <uri> [type] [payload]

• method: CoAP method to be used (GET/PUT/POST/DELETE).
• address: IPv6 address of the CoAP Secure server to query.
• uri: URI String of the resource on the CoAP server.
• type: Switch between confirmable ("con") and non-confirmable (default).
• payload: In case of PUT/POST/DELETE a payload can be encapsulated.

> coaps get 2001:1234::321 secret
Sending coap secure request: Done
Received coap secure response
    CoapSecure RX Header Informations:
        Type 16 (NON CONF)
        Code 69 (Coap Code CONTENT)
    With payload (hex):
4a756e2031322031353a30373a3336
> coaps put 2001:1234::321 test non-con hello
Sending coap secure request: Done
> coaps post 2001:1234::321 test con
Sending coap secure request: Done
Received coap secure response
    CoapSecure RX Header Informations:
        Type 32 (NON CONF)
        Code 69 (Coap Code CONTENT)
    With payload (hex):
4a756e2031322031353a30373a3336
> coaps delete 2001:1234::321 test
Sending coap secure request: Done

commissioner start <provisioningUrl>

Start the Commissioner role.

• provisioningUrl: Provisioning URL for the Joiner (optional).

This command will cause the device to send LEAD_PET and LEAD_KA messages.

> commissioner start
Done

commissioner stop

Stop the Commissioner role.

This command will cause the device to send LEAD_KA[Reject] messages.

> commissioner stop
Done

commissioner joiner add <eui64> <psdk>

Add a Joiner entry.

• eui64: The IEEE EUI-64 of the Joiner or '*' to match any Joiner.
• pskd: Pre-Shared Key for the Joiner.

> commissioner joiner add d45e64fa83f81cf7 PSK
Done

commissioner joiner remove <eui64>

Remove a Joiner entry.

• eui64: The IEEE EUI-64 of the Joiner or '*' to match any Joiner.

> commissioner joiner remove d45e64fa83f81cf7
Done

commissioner provisioningurl <provisioningUrl>

Set the Provisioning URL.

> commissioner provisioningurl http://github.com/openthread/openthread
Done

commissioner energy <mask> <count> <period> <scanDuration> <destination>

Send a MGMT_ED_SCAN message.

• mask: Bitmask identifying channsl to perform IEEE 802.15.4 ED Scans.
• count: Number of IEEE 802.15.4 ED Scans per channel.
• period: Period between successive IEEE 802.15.4 ED Scans (milliseconds).
• scanDuration: IEEE 802.15.4 ScanDuration to use when performing an IEEE 802.15.4 ED Scan (milliseconds).
• destination: IPv6 destination for the message (may be multicast).

The contents of MGMT_ED_REPORT messages (i.e. Channel Mask and Energy List) are printed as they are received.

> commissioner energy 0x00050000 2 32 1000 fdde:ad00:beef:0:0:ff:fe00:c00
Done
Energy: 00050000 0 0 0 0

commissioner panid <panid> <mask> <destination>

Send a MGMT_PANID_QUERY message.

• panid: PAN ID to check for conflicts.
• mask: Bitmask identifying channels to perform IEEE 802.15.4 Active Scans.
• destination: IPv6 destination for the message (may be multicast).

The contents of MGMT_PANID_CONFLICT messages (i.e. PAN ID and Channel Mask) are printed as they are received.

> commissioner panid 0xdead 0x7fff800 fdde:ad00:beef:0:0:ff:fe00:c00
Done
Conflict: dead, 00000800

commissioner sessionid

Get current commissioner session id.

> commissioner sessionid
0
Done

contextreusedelay

Get the CONTEXT_ID_REUSE_DELAY value.

> contextreusedelay
11
Done

contextreusedelay <delay>

Set the CONTEXT_ID_REUSE_DELAY value.

> contextreusedelay 11
Done

counter

Get the supported counter names.

>counter
mac
Done

counter <countername>

Get the counter value.

>counter mac
TxTotal: 10
    TxUnicast: 3
    TxBroadcast: 7
    TxAckRequested: 3
    TxAcked: 3
    TxNoAckRequested: 7
    TxData: 10
    TxDataPoll: 0
    TxBeacon: 0
    TxBeaconRequest: 0
    TxOther: 0
    TxRetry: 0
    TxErrCca: 0
RxTotal: 2
    RxUnicast: 1
    RxBroadcast: 1
    RxData: 2
    RxDataPoll: 0
    RxBeacon: 0
    RxBeaconRequest: 0
    RxOther: 0
    RxAddressFiltered: 0
    RxDestAddrFiltered: 0
    RxDuplicated: 0
    RxErrNoFrame: 0
    RxErrNoUnknownNeighbor: 0
    RxErrInvalidSrcAddr: 0
    RxErrSec: 0
    RxErrFcs: 0
    RxErrOther: 0

dataset

Print changes in operational dataset buffer.

> dataset activetimestamp 1234
Done
> dataset
Active Timestamp: 1234
Done

dataset help

Print meshcop dataset help menu.

> dataset help
help
active
activetimestamp
channel
channelmask
clear
commit
delay
extpanid
masterkey
meshlocalprefix
mgmtgetcommand
mgmtsetcommand
networkname
panid
pending
pendingtimestamp
pskc
securitypolicy
Done
>

dataset active

Print meshcop active operational dataset.

> dataset active
Active Timestamp: 0
Done

dataset activetimestamp <activetimestamp>

Set active timestamp.

> dataset activestamp 123456789
Done

dataset channel <channel>

Set channel.

> dataset channel 12
Done

dataset channelmask <channelmask>

Set channel mask.

> dataset channelmask e0ff1f00
Done

dataset clear

Reset operational dataset buffer.

> dataset clear
Done

dataset commit <dataset>

Commit operational dataset buffer to active/pending operational dataset.

> dataset commit active
Done

dataset delay <delay>

Set delay timer value.

> dataset delay 1000
Done

dataset extpanid <extpanid>

Set extended panid.

> dataset extpanid 000db80123456789
Done

dataset masterkey <masterkey>

Set master key.

> dataset master 1234567890123456
Done

dataset meshlocalprefix <meshlocalprefix>

Set mesh local prefix.

> dataset meshlocalprefix fd00:db8::
Done

dataset mgmtgetcommand active [address <destination>] [TLVs list] [binary]

Send MGMT_ACTIVE_GET.

> dataset mgmtgetcommand active address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp 123 binary 0001
Done

dataset mgmtsetcommand active [TLV Types list] [binary]

Send MGMT_ACTIVE_SET.

> dataset mgmtsetcommand active activetimestamp binary 820155
Done

dataset mgmtgetcommand pending [address <destination>] [TLVs list] [binary]

Send MGMT_PENDING_GET.

> dataset mgmtgetcommand pending address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp binary 0001
Done

dataset mgmtsetcommand pending [TLV Types list] [binary]

Send MGMT_PENDING_SET.

> dataset mgmtsetcommand pending activetimestamp binary 820155
Done

dataset networkname <networkname>

Set network name.

> dataset networkname openthread
Done

networktime

Get the Thread network time and the time sync parameters.

> networktime
Network Time:     21084154us (synchronized)
Time Sync Period: 100s
XTAL Threshold:   300ppm
Done

networktime <timesyncperiod> <xtalthreshold>

Set time sync parameters

• timesyncperiod: The time synchronization period, in seconds.
• xtalthreshold: The XTAL accuracy threshold for a device to become Router-Capable device, in PPM.

> networktime 100 300
Done

dataset panid <panid>

Set panid.

> dataset panid 0x1234
Done

dataset pending

Print meshcop pending operational dataset.

> dataset pending
Done

dataset pendingtimestamp <pendingtimestamp>

Set pending timestamp.

> dataset pendingtimestamp 123456789
Done

dataset pskc <pskc>

Set pskc with hex format.

> dataset pskc 67c0c203aa0b042bfb5381c47aef4d9e
Done

dataset securitypolicy <rotationtime> [onrcb]

Set security policy.

• o: Obtaining the Master Key for out-of-band commissioning is enabled.
• n: Native Commissioning using PSKc is allowed.
• r: Thread 1.x Routers are enabled.
• c: External Commissioner authentication is allowed using PSKc.
• b: Thread 1.x Beacons are enabled.

> dataset securitypolicy 672 onrcb
Done

delaytimermin

Get the minimal delay timer (in seconds).

> delaytimermin
30
Done

delaytimermin <delaytimermin>

Set the minimal delay timer (in seconds).

> delaytimermin 60
Done

discover [channel]

Perform an MLE Discovery operation.

• channel: The channel to discover on. If no channel is provided, the discovery will cover all valid channels.

> discover
| J | Network Name     | Extended PAN     | PAN  | MAC Address      | Ch | dBm | LQI |
+---+------------------+------------------+------+------------------+----+-----+-----+
| 0 | OpenThread       | dead00beef00cafe | ffff | f1d92a82c8d8fe43 | 11 | -20 |   0 |
Done

dns resolve <hostname> [DNS server IP] [DNS server port]

Send DNS Query to obtain IPv6 address for given hostname. The latter two parameters have following default values:

• DNS server IP: 2001:4860:4860::8888 (Google DNS Server)
• DNS server port: 53

> dns resolve ipv6.google.com
> DNS response for ipv6.google.com - [2a00:1450:401b:801:0:0:0:200e] TTL: 300

eidcache

Print the EID-to-RLOC cache entries.

> eidcache
fdde:ad00:beef:0:bb1:ebd6:ad10:f33 ac00
fdde:ad00:beef:0:110a:e041:8399:17cd 6000
Done

eui64

Get the factory-assigned IEEE EUI-64.

> eui64
0615aae900124b00
Done

extaddr

Get the IEEE 802.15.4 Extended Address.

> extaddr
dead00beef00cafe
Done

extaddr <extaddr>

Set the IEEE 802.15.4 Extended Address.

> extaddr dead00beef00cafe
dead00beef00cafe
Done

extpanid

Get the Thread Extended PAN ID value.

> extpanid
dead00beef00cafe
Done

extpanid <extpanid>

Set the Thread Extended PAN ID value.

> extpanid dead00beef00cafe
Done

factoryreset

Delete all stored settings, and signal a platform reset.

> factoryreset

ifconfig

Show the status of the IPv6 interface.

> ifconfig
down
Done

ifconfig up

Bring up the IPv6 interface.

> ifconfig up
Done

ifconfig down

Bring down the IPv6 interface.

> ifconfig down
Done

ipaddr

List all IPv6 addresses assigned to the Thread interface.

> ipaddr
fdde:ad00:beef: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>

Delete an IPv6 address from the Thread interface.

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

ipmaddr

List all IPv6 multicast addresses subscribed to the Thread interface.

> ipmaddr
ff05:0:0:0:0:0:0:1
ff33:40:fdde:ad00:beef:0:0:1
ff32:40:fdde:ad00:beef:0:0:1
Done

ipmaddr add <ipaddr>

Subscribe the Thread interface to the IPv6 multicast address.

> ipmaddr add ff05::1
Done

ipmaddr del <ipaddr>

Unsubscribe the Thread interface to the IPv6 multicast address.

> ipmaddr del ff05::1
Done

ipmaddr promiscuous

Get multicast promiscuous mode.

> ipmaddr promiscuous
Disabled
Done

ipmaddr promiscuous enable

Enable multicast promiscuous mode.

> ipmaddr promiscuous enable
Done

ipmaddr promiscuous disable

Disable multicast promiscuous mode.

> ipmaddr promiscuous disable
Done

joiner start <pskd> <provisioningUrl>

Start the Joiner role.

• pskd: Pre-Shared Key for the Joiner.
• provisioningUrl: Provisioning URL for the Joiner (optional).

This command will cause the device to perform an MLE Discovery and initiate the Thread Commissioning process.

> joiner start PSK
Done

joiner stop

Stop the Joiner role.

> joiner stop
Done

joinerid

Get the Joiner ID.

> joinerid
e0b220eb7d8dda7e
Done

joinerport <port>

Set the Joiner port.

> joinerport 1000
Done

keysequence counter

Get the Thread Key Sequence Counter.

> keysequence counter
10
Done

keysequence counter <counter>

Set the Thread Key Sequence Counter.

> keysequence counter 10
Done

keysequence guardtime

Get Thread Key Switch Guard Time (in hours)

> keysequence guardtime
0
Done

keysequence guardtime <guardtime>

Set Thread Key Switch Guard Time (in hours) 0 means Thread Key Switch imediately if key index match

> keysequence guardtime 0
Done

leaderpartitionid

Get the Thread Leader Partition ID.

> leaderpartitionid
4294967295
Done

leaderpartitionid <partitionid>

Set the Thread Leader Partition ID.

> leaderpartitionid 0xffffffff
Done

leaderdata

Show the Thread Leader Data.

> leaderdata
Partition ID: 1077744240
Weighting: 64
Data Version: 109
Stable Data Version: 211
Leader Router ID: 60
Done

leaderweight

Get the Thread Leader Weight.

> leaderweight
128
Done

leaderweight <weight>

Set the Thread Leader Weight.

> leaderweight 128
Done

linkquality <extaddr>

Get the link quality on the link to a given extended address.

> linkquality 36c1dd7a4f5201ff
3
Done

linkquality <extaddr> <linkquality>

Set the link quality on the link to a given extended address.

> linkquality 36c1dd7a4f5201ff 3
Done

logfilename FILENAME

• Note: POSIX Platform Only, ie: OPENTHREAD_EXAMPLES_POSIX
• Requires OPENTHREAD_CONFIG_LOG_OUTPUT == OPENTHREAD_CONFIG_LOG_OUTPUT_DEBUG_UART

Specifies filename to capture otPlatLog() messages, useful when debugging automated test scripts on Linux when logging disrupts the automated test scripts.

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 Thread 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 Thread Device
• n: Full Network Data

> mode rsdn
Done

neighbor list

List RLOC16 of neighbors.

> neighbor list
0xcc01 0xc800 0xf000
Done

neighbor table

Print table of neighbors.

> neighbor table
| Role | RLOC16 | Age | Avg RSSI | Last RSSI |R|S|D|N| Extended MAC     |
+------+--------+-----+----------+-----------+-+-+-+-+------------------+
|   C  | 0xcc01 |  96 |      -46 |       -46 |1|1|1|1| 1eb9ba8a6522636b |
|   R  | 0xc800 |   2 |      -29 |       -29 |1|0|1|1| 9a91556102c39ddb |
|   R  | 0xf000 |   3 |      -28 |       -28 |1|0|1|1| 0ad7ed6beaa6016d |
Done

netdataregister

Register local network data with Thread Leader.

> netdataregister
Done

netdatashow

Show Thread Leader network data.

> netdatashow
08040b020000
Done

networkdiagnostic get <addr> <type> ..

Send network diagnostic request to retrieve tlv of <type>s.

If <addr> is unicast address, Diagnostic Get will be sent. if <addr> is multicast address, Diagnostic Query will be sent.

> networkdiagnostic get fdde:ad00:beef:0:0:ff:fe00:f400 0 1 6
DIAG_GET.rsp: 00088e18ad17a24b0b740102f400060841dcb82d40bac63d

> networkdiagnostic get ff02::1 0 1
DIAG_GET.rsp: 0008567e31a79667a8cc0102f000
DIAG_GET.rsp: 0008aaa7e584759e4e6401025400

networkdiagnostic reset <addr> <type> ..

Send network diagnostic request to reset <addr>'s tlv of <type>s. Currently only MAC Counters(9) is supported.

> diagnostic reset fd00:db8::ff:fe00:0 9
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

parent

Get the diagnostic information for a Thread Router as parent.

Note: When operating as a Thread Router, this command will return the cached information from when the device was previously attached as a Thread Child. Returning cached information is necessary to support the Thread Test Harness - Test Scenario 8.2.x requests the former parent (i.e. Joiner Router's) MAC address even if the device has already promoted to a router.

> parent
Ext Addr: be1857c6c21dce55
Rloc: 5c00
Link Quality In: 3
Link Quality Out: 3
Age: 20
Done

parentpriority

Get the assigned parent priority value, -2 means not assigned.

> parentpriority
1
Done

parentpriority <parentpriority>

Set the assigned parent priority value: 1, 0, -1 or -2.

> parentpriority 1
Done

ping <ipaddr> [size] [count] [interval]

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 time=28ms

ping stop

Stop sending ICMPv6 Echo Requests.

> ping stop
Done

pollperiod

Get the customized data poll period of sleepy end device (milliseconds). Only for certification test

> pollperiod
0
Done

pollperiod <pollperiod>

Set the customized data poll period for sleepy end device (milliseconds >= 10ms). Only for certification test

> pollperiod 10
Done

prefix

Get the prefix list in the local Network Data.

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

prefix add <prefix> [pvdcsr] [prf]

Add a valid prefix to the Network Data.

• p: Preferred flag
• a: Stateless IPv6 Address Autoconfiguration flag
• d: DHCPv6 IPv6 Address Configuration flag
• c: DHCPv6 Other Configuration flag
• r: Default Route flag
• o: On Mesh flag
• s: Stable flag
• prf: Default router preference, which may be 'high', 'med', or 'low'.

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

prefix remove <prefix>

Invalidate a prefix in the Network Data.

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

promiscuous

Get radio promiscuous property.

> promiscuous
Disabled
Done

promiscuous enable

Enable radio promiscuous operation and print raw packet content.

> promiscuous enable
Done

promiscuous disable

Disable radio promiscuous operation.

> promiscuous disable
Done

releaserouterid <routerid>

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

> releaserouterid 16
Done

reset

Signal a platform reset.

> reset

rloc16

Get the Thread RLOC16 value.

> rloc16
0xdead
Done

route

Get the external route list in the local Network Data.

> route
2001:dead:beef:cafe::/64 s med
Done

route add <prefix> [s] [prf]

Add a valid external route to the Network Data.

• s: Stable flag
• prf: Default Router Preference, which may be: 'high', 'med', or 'low'.

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

route remove <prefix>

Invalidate a external route in the Network Data.

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

router list

List allocated Router IDs.

> router list
8 24 50
Done

router table

Print table of routers.

> router table
| ID | RLOC16 | Next Hop | Path Cost | LQ In | LQ Out | Age | Extended MAC     |
+----+--------+----------+-----------+-------+--------+-----+------------------+
| 21 | 0x5400 |       21 |         0 |     3 |      3 |   5 | d28d7f875888fccb |
| 56 | 0xe000 |       56 |         0 |     0 |      0 | 182 | f2d92a82c8d8fe43 |
Done

router <id>

Print diagnostic information for a Thread Router. The id may be a Router ID or an RLOC16.

> router 50
Alloc: 1
Router ID: 50
Rloc: c800
Next Hop: c800
Link: 1
Ext Addr: e2b3540590b0fd87
Cost: 0
Link Quality In: 3
Link Quality Out: 3
Age: 3
Done

> router 0xc800
Alloc: 1
Router ID: 50
Rloc: c800
Next Hop: c800
Link: 1
Ext Addr: e2b3540590b0fd87
Cost: 0
Link Quality In: 3
Link Quality Out: 3
Age: 7
Done

routerdowngradethreshold

Get the ROUTER_DOWNGRADE_THRESHOLD value.

> routerdowngradethreshold
23
Done

routerdowngradethreshold <threshold>

Set the ROUTER_DOWNGRADE_THRESHOLD value.

> routerdowngradethreshold 23
Done

routerrole

Indicates whether the router role is enabled or disabled.

> routerrole
Enabled
Done

routerrole enable

Enable the router role.

> routerrole enable
Done

routerrole disable

Disable the router role.

> routerrole disable
Done

routerselectionjitter

Get the ROUTER_SELECTION_JITTER value.

> routerselectionjitter
120
Done

routerselectionjitter <jitter>

Set the ROUTER_SELECTION_JITTER value.

> routerselectionjitter 120
Done

routerupgradethreshold

Get the ROUTER_UPGRADE_THRESHOLD value.

> routerupgradethreshold
16
Done

routerupgradethreshold <threshold>

Set the ROUTER_UPGRADE_THRESHOLD value.

> routerupgradethreshold 16
Done

scan [channel]

Perform an IEEE 802.15.4 Active Scan.

• channel: The channel to scan on. If no channel is provided, the active scan will cover all valid channels.

> scan
| J | Network Name     | Extended PAN     | PAN  | MAC Address      | Ch | dBm | LQI |
+---+------------------+------------------+------+------------------+----+-----+-----+
| 0 | OpenThread       | dead00beef00cafe | ffff | f1d92a82c8d8fe43 | 11 | -20 |   0 |
Done

scan energy [duration]

Perform an IEEE 802.15.4 Energy Scan.

• duration: The time in milliseconds to spend scanning each channel.

> scan energy 10
| Ch | RSSI |
+----+------+
| 11 |  -59 |
| 12 |  -62 |
| 13 |  -67 |
| 14 |  -61 |
| 15 |  -87 |
| 16 |  -86 |
| 17 |  -86 |
| 18 |  -52 |
| 19 |  -58 |
| 20 |  -82 |
| 21 |  -76 |
| 22 |  -82 |
| 23 |  -74 |
| 24 |  -81 |
| 25 |  -88 |
| 26 |  -71 |
Done

singleton

Return true when there are no other nodes in the network, otherwise return false.

> singleton
true or false
Done

sntp query [SNTP server IP] [SNTP server port]

Send SNTP Query to obtain current unix epoch time (from 1st January 1970). The latter two parameters have following default values:

• NTP server IP: 2001:4860:4806:8:: (Google IPv6 NTP Server)
• NTP server port: 123

> sntp query
> SNTP response - Unix time: 1540894725 (era: 0)

You can use NAT64 of OpenThread Border Router to reach e.g. Google IPv4 NTP Server:

> sntp query 64:ff9b::d8ef:2308
> SNTP response - Unix time: 1540898611 (era: 0)

state

Return state of current state.

> state
offline, disabled, detached, child, router or leader
Done

state

Try to switch to state detached, child, router or leader.

> state leader
Done

thread start

Enable Thread protocol operation and attach to a Thread network.

> thread start
Done

thread stop

Disable Thread protocol operation and detach from a Thread network.

> thread stop
Done

txpower

Get the transmit power in dBm.

> txpower
-10 dBm
Done

txpower <txpower>

Set the transmit power.

> txpower -10
Done

version

Print the build version information.

> version
OPENTHREAD/gf4f2f04; Jul  1 2016 17:00:09
Done

macfilter

List the macfilter status, including address and received signal strength filter settings.

> macfilter
Address Mode: Whitelist
0f6127e33af6b403 : rss -95 (lqi 1)
0f6127e33af6b402
RssIn List:
0f6127e33af6b403 : rss -95 (lqi 1)
Default rss : -50 (lqi 3)
Done

macfilter addr

List the address filter status.

> macfilter addr
Whitelist
0f6127e33af6b403 : rss -95 (lqi 1)
0f6127e33af6b402
Done

macfilter addr disable

Disable address filter mode.

> macfilter addr disable
Done

macfilter addr whitelist

Enable whitelist address filter mode.

> macfilter addr whitelist
Done

macfilter addr blacklist

Enable blacklist address filter mode.

> macfilter addr blacklist
Done

macfilter addr add <extaddr> [rss]

Add an IEEE 802.15.4 Extended Address to the address filter, and fixed the received singal strength for the messages from the address if rss is specified.

> macfilter addr add 0f6127e33af6b403 -95
Done

> macfilter addr add 0f6127e33af6b402
Done

macfilter addr remove <extaddr>

Remove the IEEE802.15.4 Extended Address from the address filter.

> macfilter addr remove 0f6127e33af6b402
Done

macfilter addr clear

Clear all the IEEE802.15.4 Extended Addresses from the address filter.

> macfilter addr clear
Done

macfilter rss

List the rss filter status

> macfilter rss
0f6127e33af6b403 : rss -95 (lqi 1)
Default rss: -50 (lqi 3)
Done

macfilter rss add <extaddr> <rss>

Set the received signal strength for the messages from the IEEE802.15.4 Extended Address. If extaddr is *, default received signal strength for all received messages would be set.

> macfilter rss add * -50
Done

> macfilter rss add 0f6127e33af6b404 -85
Done

macfilter rss add-lqi <extaddr> <lqi>

Set the received link quality for the messages from the IEEE802.15.4 Extended Address. Valid lqi range [0,3] If extaddr is *, default received link quality for all received messages would be set. Equivalent with 'filter rss add' with similar usage

> macfilter rss add-lqi * 3
Done

> macfilter rss add 0f6127e33af6b404 2
Done

macfilter rss remove <extaddr>

Removes the received signal strength or received link quality setting on the Extended Address. If extaddr is *, default received signal strength or link quality for all received messages would be unset.

> macfilter rss remove *
Done

> macfilter rss remove 0f6127e33af6b404
Done

macfilter rss clear

Clear all the received signal strength or received link quality settings.

> macfilter rss clear
Done

diag

Diagnostics module is enabled only when building OpenThread with --enable-diag option. Go diagnostics module for more information.

service

Module for controlling service registration in Network Data. Each change in service registration must be sent to leader by netdataregister command before taking effect.

service add <enterpriseNumber> <serviceData> <serverData>

Add service to the Network Data.

> service add 44970 foo bar
Done
> ipaddr
fdde:ad00:beef:0:0:ff:fe00:fc10
fdde:ad00:beef:0:0:ff:fe00:fc00
fdde:ad00:beef:0:0:ff:fe00:7c00
fe80:0:0:0:1486:2f57:3c:6e10
fdde:ad00:beef:0:8ca4:19ed:217a:eff9
Done

service remove <enterpriseNumber> <serviceData>

Remove service from Network Data.

> service remove 44970 foo
Done