Resources

Applies to:

Want to experience Defender for Endpoint? Sign up for a free trial.

Collect diagnostic information

If you can reproduce a problem, first increase the logging level, run the system for some time, and then restore the logging level to the default.

  1. Increase logging level:

    mdatp log level set --level debug
    
    Log level configured successfully
    
  2. Reproduce the problem.

  3. Run the following command to back up Defender for Endpoint's logs. The files will be stored inside of a .zip archive.

    sudo mdatp diagnostic create
    

    This command will also print out the file path to the backup after the operation succeeds:

    Diagnostic file created: <path to file>
    
  4. Restore logging level:

    mdatp log level set --level info
    
    Log level configured successfully
    

Log installation issues

If an error occurs during installation, the installer will only report a general failure.

The detailed log will be saved to /var/log/microsoft/mdatp/install.log. If you experience issues during installation, send us this file so we can help diagnose the cause.

Uninstall

There are several ways to uninstall Defender for Endpoint on Linux. If you are using a configuration tool such as Puppet, follow the package uninstallation instructions for the configuration tool.

Manual uninstallation

  • sudo yum remove mdatp for RHEL and variants(CentOS and Oracle Linux).
  • sudo zypper remove mdatp for SLES and variants.
  • sudo apt-get purge mdatp for Ubuntu and Debian systems.

Configure from the command line

Important tasks, such as controlling product settings and triggering on-demand scans, can be done from the command line.

Global options

By default, the command-line tool outputs the result in human-readable format. In addition, the tool also supports outputting the result as JSON, which is useful for automation scenarios. To change the output to JSON, pass --output json to any of the below commands.

Supported commands

The following table lists commands for some of the most common scenarios. Run mdatp help from the Terminal to view the full list of supported commands.



Group Scenario Command
Configuration Turn on/off real-time protection mdatp config real-time-protection --value [enabled\|disabled]
Configuration Turn on/off behavior monitoring mdatp config behavior-monitoring --value [enabled\|disabled]
Configuration Turn on/off cloud protection mdatp config cloud --value [enabled\|disabled]
Configuration Turn on/off product diagnostics mdatp config cloud-diagnostic --value [enabled\|disabled]
Configuration Turn on/off automatic sample submission mdatp config cloud-automatic-sample-submission [enabled\|disabled]
Configuration Turn on/off AV passive mode mdatp config passive-mode --value [enabled\|disabled]
Configuration Add/remove an antivirus exclusion for a file extension mdatp exclusion extension [add\|remove] --name [extension]
Configuration Add/remove an antivirus exclusion for a file mdatp exclusion file [add\|remove] --path [path-to-file]
Configuration Add/remove an antivirus exclusion for a directory mdatp exclusion folder [add\|remove] --path [path-to-directory]
Configuration Add/remove an antivirus exclusion for a process mdatp exclusion process [add\|remove] --path [path-to-process]

mdatp exclusion process [add\|remove] --name [process-name]

Configuration List all antivirus exclusions mdatp exclusion list
Configuration Add a threat name to the allowed list mdatp threat allowed add --name [threat-name]
Configuration Remove a threat name from the allowed list mdatp threat allowed remove --name [threat-name]
Configuration List all allowed threat names mdatp threat allowed list
Configuration Turn on PUA protection mdatp threat policy set --type potentially_unwanted_application --action block
Configuration Turn off PUA protection mdatp threat policy set --type potentially_unwanted_application --action off
Configuration Turn on audit mode for PUA protection mdatp threat policy set --type potentially_unwanted_application --action audit
Configuration Configure degree of parallelism for on-demand scans mdatp config maximum-on-demand-scan-threads --value [numerical-value-between-1-and-64]
Configuration Turn on/off scans after security intelligence updates mdatp config scan-after-definition-update --value [enabled/disabled]
Configuration Turn on/off archive scanning (on-demand scans only) mdatp config scan-archives --value [enabled/disabled]
Diagnostics Change the log level mdatp log level set --level verbose [error|warning|info|verbose]
Diagnostics Generate diagnostic logs mdatp diagnostic create --path [directory]
Health Check the product's health mdatp health
Protection Scan a path mdatp scan custom --path [path] [--ignore-exclusions]
Protection Do a quick scan mdatp scan quick
Protection Do a full scan mdatp scan full
Protection Cancel an ongoing on-demand scan mdatp scan cancel
Protection Request a security intelligence update mdatp definitions update
Protection history Print the full protection history mdatp threat list
Protection history Get threat details mdatp threat get --id [threat-id]
Quarantine management List all quarantined files mdatp threat quarantine list
Quarantine management Remove all files from the quarantine mdatp threat quarantine remove-all
Quarantine management Add a file detected as a threat to the quarantine mdatp threat quarantine add --id [threat-id]
Quarantine management Remove a file detected as a threat from the quarantine mdatp threat quarantine remove --id [threat-id]
Quarantine management Restore a file from the quarantine mdatp threat quarantine restore --id [threat-id] --path [destination-folder]
Endpoint Detection and Response Set early preview (unused) mdatp edr early-preview [enable|disable]
Endpoint Detection and Response Set group-id mdatp edr group-ids --group-id [group-id]
Endpoint Detection and Response Set / remove tag, only GROUP supported mdatp edr tag set --name GROUP --value [tag]
Endpoint Detection and Response List exclusions (root) mdatp edr exclusion list [processes|paths|extensions|all]