Knowledgebase

Overview

Sentinel includes a command-line interface (CLI) designed to streamline configuration across multiple servers and integrate with automated deployment tools such as Ansible. For comprehensive documentation, refer to the official CLI guide.

Syntax and Formatting Rules

When executing CLI commands, adhere to the following formatting standards:

• Assign option values using an equal sign (=).
• Enclose values containing spaces or semicolons in single quotes.
• If a value requires literal single quotes, wrap the entire value in single quotes and escape internal quotes by replacing each with '\''.
• All options are case-sensitive. Ensure exact capitalization when specifying tasks and parameters.

Command Usage and Task Reference

Execute the following syntax to run CLI operations:

Usage:

sentinel --task={task} --option1=value1 --option2=value2

Where {task} is one of the following:

  * antimalware:antimalware
  * antimalware:domainmonitoring
  * antimalware:ignore
  * antimalware:monitoring
  * antimalware:monitoring:paths
  * antimalware:quarantine
  * antimalware:scanning
  * antimalware:scanning:schedule
  * antimalware:statisticalanalysis
  * antivirus:antivirus
  * antivirus:scanning
  * antivirus:scanninglimits
  * antivirus:signatureproviders
  * antivirus:signatureupdates
  * application:about
  * application:application
  * application:dashboard
  * application:geolocation
  * application:license
  * application:maintenance
  * application:maintenance:database
  * application:setup
  * application:update
  * help

For more information on what a task does and usage details execute:

sentinel --task={task} --help

Configuration Examples

The following examples demonstrate common CLI operations:

// install the sentinel extension
plesk bin extension --install-url https://www.danami.com/clients/downloads/sentinel.zip

// Run the setup wizard to active the extension license, run the application installer, and configure the application
sentinel --task=application:setup --license_key=XXXXXX

Troubleshooting

If commands fail or return unexpected errors, verify the following:

• Case Sensitivity: Confirm that all task names and option flags match the exact capitalization shown in the documentation.
• Quoting Syntax: Ensure values with spaces or special characters are properly enclosed in single quotes. Verify that internal single quotes are escaped using '\''.
• Assignment Operator: Use an equal sign (=) between options and their corresponding values, without surrounding spaces.