Skip to main content
Version: DPX 4.9

Getting Started with the Command-line Interface for the Catalogic DPX GuardMode

In the Microsoft Windows system with the Catalogic DPX GuardMode, start a new session of Microsoft Windows PowerShell 5.1 with the administrator privilege. That is, open Start menu in the task bar, search applications for Windows PowerShell, right-click this application, and click Run as administrator. Ensure that you can see Administrator: Windows PowerShell in the title bar of the application window.

Go to the folder of the Catalogic DPX GuardMode application. You can use the Set-Location command which is similar to the following example:

PS> Set-Location -Path 'C:\Program Files\DPX\Ransomware Detection Agent\'

A typical syntax of the command-line interface for the Catalogic DPX GuardMode is structured as shown:

PS> Catalogic.RansomwareDetection.Agent.exe <Mode[]> [<Flag> <string>]

For each operation, use a command with either mode, and some modes can take multiple string arguments:

  • run to start the Catalogic DPX GuardMode agent.
  • register to register the Catalogic DPX GuardMode agent with another system.
    • dpx for the Catalogic DPX Master Server
  • config [ add | list | remove | update ] to configure the Catalogic DPX GuardMode.
    • add to add configuration items.
      • notification-provider for a notification provider
        • dpx for the Catalogic DPX Master Server
    • list to list available configuration items.
      • notification-provider for a notification provider
        • dpx for Catalogic DPX Master Server
    • remove to remove configuration items.
      • notification-provider for a notification provider
        • dpx for the Catalogic DPX Master Server
    • update [ notification-provider | basic-authentication ] to update configuration items.
      • notification-provider for a notification provider
        • dpx for the Catalogic DPX Master Server
      • basic-authentication for the Catalogic DPX GuardMode REST API basic authentication

Add flags and parameters after the mode strings. There are required flags and optional flags. For example, you can add the optional flag, --help, to any command and see description of it.