otDatasetUpdateTlvs() function

Specifies the set of types and values to update.

A pointer to dataset TLVs to update.

@cli dataset securitypolicy (get,set) @cparam dataset securitypolicy [@ca{rotationtime} [@ca{onrcCepR}]] * Use `rotationtime` for `thrKeyRotation`, in units of hours. * Security Policy commands use the `onrcCepR` argument mappings to get and set #otSecurityPolicy members, for example `o` represents #otSecurityPolicy::mObtainNetworkKeyEnabled. @moreinfo{@dataset}. @par Gets or sets the %Dataset security policy.

Gets the Active Operational Dataset.

Parses an Operational Dataset from a given `otOperationalDatasetTlvs`.

For FTD only, creates a new Operational Dataset to use when forming a new network.

@cli dataset delay (get,set) @cparam dataset delay [@ca{delay}] Use the optional `delay` argument to set the delay timer value. @par Gets or sets #otOperationalDataset::mDelay. @sa otDatasetSetDelayTimerMinimal

@cli dataset meshlocalprefix (get,set) @cparam dataset meshlocalprefix [@ca{meshlocalprefix}] Use the optional `meshlocalprefix` argument to set the Mesh-Local Prefix. @par Gets or sets #otOperationalDataset::mMeshLocalPrefix.

Sets the Active Operational Dataset. If the dataset does not include an Active Timestamp, the dataset is only partially complete. If Thread is enabled on a device that has a partially complete Active Dataset, the device will attempt to attach to an existing Thread network using any existing information in the dataset. Only the Thread Network Key is needed to attach to a network. If channel is not included in the dataset, the device will send MLE Announce messages across different channels to find neighbors on other channels. If the device successfully attaches to a Thread network, the device will then retrieve the full Active Dataset from its Parent. Note that a router-capable device will not transition to the Router or Leader roles until it has a complete Active Dataset. This function consistently returns `OT_ERROR_NONE` and can effectively be treated as having a `void` return type. Previously, other errors (e.g., `OT_ERROR_NOT_IMPLEMENTED`) were allowed for legacy reasons. However, as non-volatile storage is now mandatory for Thread operation, any failure to save the dataset will trigger an assertion. The `otError` return type is retained for backward compatibility.

Gets the Pending Operational Dataset.

Sends MGMT_ACTIVE_SET.

Sends MGMT_PENDING_SET.

Converts a given Operational Dataset to `otOperationalDatasetTlvs`.

@cli dataset activetimestamp (get, set) @cparam dataset activetimestamp [@ca{timestamp}] Pass the optional `timestamp` argument to set the active timestamp. @par Gets or sets #otOperationalDataset::mActiveTimestamp.

@cli dataset channel (get,set) @cparam dataset channel [@ca{channel-num}] Use the optional `channel-num` argument to set the channel. @par Gets or sets #otOperationalDataset::mChannel.

@cli dataset wakeupchannel (get,set) @cparam dataset wakeupchannel [@ca{channel-num}] Use the optional `channel-num` argument to set the wake-up channel. @par Gets or sets #otOperationalDataset::mWakeupChannel.

@cli dataset channelmask (get,set) @cparam dataset channelmask [@ca{channel-mask}] Use the optional `channel-mask` argument to set the channel mask. @par Gets or sets #otOperationalDataset::mChannelMask

@cli dataset extpanid (get,set) @cparam dataset extpanid [@ca{extpanid}] Use the optional `extpanid` argument to set the Extended Personal Area Network ID. @par Gets or sets #otOperationalDataset::mExtendedPanId.

@cli dataset networkkey (get,set) @cparam dataset networkkey [@ca{key}] Use the optional `key` argument to set the Network Key. @par Gets or sets #otOperationalDataset::mNetworkKey.

@cli dataset networkname (get,set) @cparam dataset networkname [@ca{name}] Use the optional `name` argument to set the Network Name. @par Gets or sets #otOperationalDataset::mNetworkName.

@cli dataset panid (get,set) @cparam dataset panid [@ca{panid}] Use the optional `panid` argument to set the PAN ID. @par Gets or sets #otOperationalDataset::mPanId.

@cli dataset pendingtimestamp (get,set) @cparam dataset pendingtimestamp [@ca{timestamp}] Use the optional `timestamp` argument to set the pending timestamp seconds. @par Gets or sets #otOperationalDataset::mPendingTimestamp.

@cli dataset pskc (get,set) @cparam dataset pskc [@ca{-p} @ca{passphrase}] | [@ca{key}] For FTD only, use `-p` with the `passphrase` argument. `-p` generates a pskc from the UTF-8 encoded `passphrase` that you provide, together with the network name and extended PAN ID. If set, `-p` uses the dataset buffer; otherwise, it uses the current stack. Alternatively, you can set pskc as `key` (hex format). @par Gets or sets #otOperationalDataset::mPskc.

Sets the Pending Operational Dataset. This function consistently returns `OT_ERROR_NONE` and can effectively be treated as having a `void` return type. Previously, other errors (e.g., `OT_ERROR_NOT_IMPLEMENTED`) were allowed for legacy reasons. However, as non-volatile storage is now mandatory for Thread operation, any failure to save the dataset will trigger an assertion. The `otError` return type is retained for backward compatibility.

Requests an update to Operational Dataset. Available when `OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE` is enabled. @p aDataset should contain the fields to be updated and their new value. It must not contain Active or Pending Timestamp fields. The Delay field is optional, if not provided a default value (1000 ms) would be used.