Thread network configuration parameters are managed using Active and Pending Operational Dataset objects.
The Active Operational Dataset includes parameters that are currently in use across an entire Thread network. The Active Operational Dataset contains:
The Pending Operational Dataset is used to communicate changes to the Active Operational Dataset before they take effect. The Pending Operational Dataset contains all the parameters from the Active Operational Dataset, with the addition of:
Generate and view new network configuration.
> dataset init new Done > dataset Active Timestamp: 1 Channel: 13 Channel Mask: 0x07fff800 Ext PAN ID: d63e8e3e495ebbc3 Mesh Local Prefix: fd3d:b50b:f96d:722d::/64 Master Key: dfd34f0f05cad978ec4e32b0413038ff Network Name: OpenThread-8f28 PAN ID: 0x8f28 PSKc: c23a76e98f1a6483639b1ac1271e2e27 Security Policy: 0, onrcb Done
Commit new dataset to the Active Operational Dataset in non-volatile storage.
dataset commit active Done
Enable Thread interface
> ifconfig up Done > thread start Done
Only the Master Key is required for a device to attach to a Thread network.
While not required, specifying the channel avoids the need to search across multiple channels, improving both latency and efficiency of the attach process.
After the device successfully attaches to a Thread network, the device will retrieve the complete Active Operational Dataset.
Create a partial Active Operational Dataset.
> dataset masterkey dfd34f0f05cad978ec4e32b0413038ff Done > dataset commit active Done
Enable Thread interface.
> ifconfig up Done > thread start Done
After attaching, validate that the device received the complete Active Operational Dataset.
> dataset active Active Timestamp: 1 Channel: 13 Channel Mask: 0x07fff800 Ext PAN ID: d63e8e3e495ebbc3 Mesh Local Prefix: fd3d:b50b:f96d:722d::/64 Master Key: dfd34f0f05cad978ec4e32b0413038ff Network Name: OpenThread-8f28 PAN ID: 0x8f28 PSKc: c23a76e98f1a6483639b1ac1271e2e27 Security Policy: 0, onrcb Done
Usage: dataset help
Print dataset help menu.
> dataset help help active activetimestamp channel channelmask clear commit delay extpanid init masterkey meshlocalprefix mgmtgetcommand mgmtsetcommand networkname panid pending pendingtimestamp pskc securitypolicy Done
Usage: dataset active [-x]
Print Active Operational Dataset in human-readable form.
> dataset active Active Timestamp: 1 Channel: 13 Channel Mask: 0x07fff800 Ext PAN ID: d63e8e3e495ebbc3 Mesh Local Prefix: fd3d:b50b:f96d:722d::/64 Master Key: dfd34f0f05cad978ec4e32b0413038ff Network Name: OpenThread-8f28 PAN ID: 0x8f28 PSKc: c23a76e98f1a6483639b1ac1271e2e27 Security Policy: 0, onrcb Done
Print Active Operational Dataset as hex-encoded TLVs.
> dataset active -x 0e080000000000010000000300001035060004001fffe002084eb74ab03c56e6d00708fdc7fe165c83a67805108e2104f183e698da87e96efc1e45aa51030f4f70656e5468726561642d383631310102861104108d6273023d82c841eff0e68db86f35740c030000ff Done
Usage: dataset activetimestamp [timestamp]
Get active timestamp.
> dataset activetimestamp 123456789 Done
Set active timestamp.
> dataset activetimestamp 123456789 Done
Usage: channel [channel]
Get channel.
> dataset channel 12 Done
Set channel.
> dataset channel 12 Done
Usage: dataset channelmask [channelmask]
Get channel mask.
> dataset channelmask 0x07fff800 Done
Set channel mask.
> dataset channelmask 0x07fff800 Done
Usage: dataset clear
Reset operational dataset buffer.
> dataset clear Done
Usage: dataset commit <active|pending>
Commit operational dataset buffer to active/pending operational dataset.
> dataset commit active Done
Usage: dataset delay [delay]
Get delay timer value.
> dataset delay 1000 Done
Set delay timer value.
> dataset delay 1000 Done
Usage: dataset extpanid [extpanid]
Get extended panid.
> dataset extpanid 000db80123456789 Done
Set extended panid.
NOTE The commissioning credential in the dataset buffer becomes stale after changing this value. Use pskc to reset.
> dataset extpanid 000db80123456789 Done
Usage: dataset init <active|new|pending>
Initialize operational dataset buffer.
> dataset init new Done
Usage: dataset masterkey [key]
Get master key
> dataset masterkey 00112233445566778899aabbccddeeff Done
Set master key.
> dataset masterkey 00112233445566778899aabbccddeeff Done
Usage: dataset meshlocalprefix [prefix]
Get mesh local prefix.
> dataset meshlocalprefix fd00:db8:0:0::/64 Done
Set mesh local prefix.
> dataset meshlocalprefix fd00:db8:: Done
Usage: dataset mgmtgetcommand <active|pending> [address <destination>] [TLV list] [-x]
Send MGMT_ACTIVE_GET or MGMT_PENDING_GET.
> dataset mgmtgetcommand active address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp -x 0c030001ff Done
Usage: dataset mgmtsetcommand <active|pending> [TLV Type list] [-x]
Send MGMT_ACTIVE_SET or MGMT_PENDING_SET.
> dataset mgmtsetcommand active activetimestamp 123 -x 0c030001ff Done
Usage: dataset networkname [name]
Get network name.
> datset networkname OpenThread Done
Set network name.
NOTE The commissioning credential in the dataset buffer becomes stale after changing this value. Use pskc to reset.
> dataset networkname OpenThread Done
Usage: dataset panid [panid]
Get panid.
> dataset panid 0x1234 Done
Set panid.
> dataset panid 0x1234 Done
Usage: dataset pending [-x]
Print Pending Operational Dataset in human-readable form.
> dataset pending Pending Timestamp: 2 Active Timestamp: 15 Channel: 16 Channel Mask: 0x07fff800 Delay: 58706 Ext PAN ID: d63e8e3e495ebbc3 Mesh Local Prefix: fd3d:b50b:f96d:722d::/64 Master Key: dfd34f0f05cad978ec4e32b0413038ff Network Name: OpenThread-8f28 PAN ID: 0x8f28 PSKc: c23a76e98f1a6483639b1ac1271e2e27 Security Policy: 0, onrcb Done
Print Pending Operational Dataset as hex-encoded TLVs.
> dataset pending -x 0e080000000000010000000300001035060004001fffe002084eb74ab03c56e6d00708fdc7fe165c83a67805108e2104f183e698da87e96efc1e45aa51030f4f70656e5468726561642d383631310102861104108d6273023d82c841eff0e68db86f35740c030000ff Done
Usage: dataset pendingtimestamp [timestamp]
Get pending timestamp.
> dataset pendingtimestamp 123456789 Done
Set pending timestamp.
> dataset pendingtimestamp 123456789 Done
Usage: pskc [-p] [<key>|<passphrase>]
Get pskc.
> dataset pskc 67c0c203aa0b042bfb5381c47aef4d9e Done
Set pskc.
With -p
(only for FTD) generate pskc from <passphrase> (UTF-8 encoded) together with network name and extended PAN ID in the dataset buffer if set or values in the current stack if not, otherwise set pskc as <key> (hex format).
> dataset pskc 67c0c203aa0b042bfb5381c47aef4d9e Done > dataset pskc -p 123456 Done
Usage: dataset securitypolicy [<rotationtime> [onrcb]]
Get security policy.
> dataset securitypolicy 672 onrcb Done
Set security policy.
> dataset securitypolicy 672 onrcb Done
Usage: dataset set <active|pending> <dataset>
Set the Active Operational Dataset using hex-encoded TLVs.
dataset set active 0e080000000000010000000300001035060004001fffe002084eb74ab03c56e6d00708fdc7fe165c83a67805108e2104f183e698da87e96efc1e45aa51030f4f70656e5468726561642d383631310102861104108d6273023d82c841eff0e68db86f35740c030000ff Done
Set the Pending Operational Dataset using hex-encoded TLVs.
dataset set pending 0e080000000000010000000300001035060004001fffe002084eb74ab03c56e6d00708fdc7fe165c83a67805108e2104f183e698da87e96efc1e45aa51030f4f70656e5468726561642d383631310102861104108d6273023d82c841eff0e68db86f35740c030000ff Done