Microsoft Defender for IoT
General

Configure and Customize Defender-IoT-micro-agent for Eclipse ThreadX

In brief

The page clarifies distribution-file selection, CMake and IAR build instructions, configuration-setting descriptions, network activity collection, Log Analytics guidance, and related-content links. The security alerts and API links are now marked as preview.

What Defender admins need to know

Administrators configuring ThreadX devices can follow the revised guidance and links. No administrator action is required.

Summaries are generated from the documentation change itself.

Documentation change

The comparison below shows only the changed extract. Use the full-page view for complete context.

Configure and customize Defender-IoT-micro-Microsoft Defender for IoT micro agent for Eclipse ThreadX

This article describes how to configure the Defender-IoT-micro-agent for your Eclipse ThreadX device,device to meet your network, bandwidth, and memory requirements. You learn how to select a target distribution, tune device behavior settings, adjust data collection intervals, and enable or disable individual collectors for resource-constrained devices.

[!INCLUDE device-agents-note]

Configure the Defender-IoT-micro-agent

You must select a target distribution file that has a *.dist extension,extension from the netxduo/addons/azure_iot/azure_iot_security_module/configs directory.

When using a CMake compilation environment, you must set a command line parameter to IOT_SECURITY_MODULE_DIST_TARGET for the chosen value. For example,example: -DIOT_SECURITY_MODULE_DIST_TARGET=RTOS_BASE.

In an IAR, or other non CMake compilation environment, you must add the netxduo/addons/azure_iot/azure_iot_security_module/inc/configs/<target distribution>/ path to any known included paths. For example,example: netxduo/addons/azure_iot/azure_iot_security_module/inc/configs/RTOS_BASE.

Configure device behavior settings

In a CMake compilation environment, you must change the default configuration by editing the netxduo/addons/azure_iot/azure_iot_security_module/configs/<target distribution>.dist file. Use the following CMake format set(ASC_XXX ON), or the following file netxduo/addons/azure_iot/azure_iot_security_module/inc/configs/<target distribution>/asc_config.h for all other environments. For example, #define ASC_XXX.

The default behavior of eachvalues for the general, data collection, and collector configuration issettings are provided in the following tables:

Configure general micro agent settings

The following table lists the general configuration settings and their default values.values:

Name Type Default Details

Configure data collection settings

The following table lists the data collection configuration settings and their default values.values:

Name Type Default Details
ASC_MEDIUM_PRIORITY_INTERVAL Number 30 The collector's medium priority group interval (in seconds).
ASC_LOW_PRIORITY_INTERVAL Number 145,440 The collector's low priority group interval (in seconds).

CollectorConfigure network activity collection

To customize your collector network activity configuration, use the following:

Available collectors

The following table lists the available collector enablement flags.flags:

Name Type Default Details
ASC_COLLECTOR_NETWORK_ACTIVITY_ENABLED Boolean ON Enables the network activity collector.
ASC_COLLECTOR_SYSTEM_INFORMATION_ENABLED Boolean ON Enables the system information collector.

Other configurations flags are advanced,advanced and have unsupported features. Contact support to change these advanced configuration flags, or for more information.

Supported security alerts and recommendations

The Defender-IoT-micro-agent for Eclipse ThreadX supports specific security alerts and recommendations. Make sure to customize the security alert and recommendation values for Eclipse ThreadX for your service.

Log Analytics (optional)

You can enable and configure Log Analytics to investigate device events and activities. ReadLearn about how to setup,set up and use Log Analytics with the Defender for IoT service to learn more. .

Next stepsRelated content