Menu

Debug mode

We understand that successfully deploying your policies and settings correctly is important. To help you test and deploy your configurations, Knox Service Plugin (KSP) includes a setting called Debug mode.

Overview

By default, KSP runs in the background and does not have a UI. Debug mode enables you to easily see policy results and errors on a device, so you can verify that your configurations are correct. When turned on, it launches an app that displays the status of policies. This app should auto-launch when it receives any new polices.

NOTE—We recommend you use Debug mode with a limited number of devices. You should turn it off for full deployments.

Here's an example of debug mode when opened manually on a device.

The app provides a list of the polices that you have pushed, along with details about the last configuration including:

  • Policy title—Name of the policy.
  • Updated—Last time the policy was updated, in the format yyyy/mm/dd.
  • Message—The status or error messages that accompany the pushed policies, such as Success, Failed, or Conditional.

For example, the following screenshot shows this information.

  • Disable fingerprint authentication
  • Updated 2018/10/12
  • Message: Success. Fingerprint authentication is disabled.

When you first open the app, it only shows the most recent pushed configuration. Click this configuration to expand the link.

Activate Debug mode

Debug mode is activated inside your UEM console when you are pushing your policies. For example, if you are trying to debug the disable fingerprint authentication feature, follow these steps in your UEM:

  1. Turn on the Debug mode flag.
  2. Under password policies, choose Disable fingerprint.
  3. Push the policies to a device.
  4. Check the KSP app for debug information. If, for any reason, the app does not launch, confirm:
    • Confirm that the device is using latest Google Play services and Play client application.
    • Confirm the UEM has pushed the appropriate policies to the device. Some UEMs have a delay between the time a policy is saved on the console and when it is received by the device. You may have to open the UEM agent on the device and preform a manual refresh to receive the policy. Refer to your UEM’s instructions for more information.

The location and appearance of the Debug mode feature in your UEM console may vary depending upon your UEM UI. Here is an example of how it may look.

Debug mode features

You can perform the following actions when Debug mode is activated.

  • To apply any updated policies, tap Apply Latest Policies.
  • To list all configuration data, tap the latest configuration, the following screenshot shows the latest configuration as Configuration on 2019/05/09.
  • NOTE—You can also click Configuration results to change the menu to Policies received. This action provides the policy in JSON format.
  • To get a log of the current configurations, tap the more menu and tap Export results.

Successful policies are displayed in black text.
Failed policies are displayed in red text.