Command Line Interface

Warden comes with a command line interface (CLI) that you can use to configure it from the command line.

• Option values should be set using the equal sign (=).
• If an option value has spaces or semicolons then the value should be wrapped in single quotes.
• If an option value needs single quotes then the value should be wrapped in single quotes with value single quotes properly escaped replacing a single quote with '\''
• Options are case sensitive.

Using the CLI

Run the following command for more information:

/usr/local/psa/admin/sbin/modules/warden/minion --task=help

Minion is a cli tool for performing tasks

Usage:

/usr/local/psa/admin/sbin/modules/warden/minion --task={task} --option1=value1 --option2=value2

Where {task} is one of the following:

  * antispam:antispam
  * antispam:learning
  * antispam:network
  * antispam:plugin:asn
  * antispam:plugin:dcc
  * antispam:plugin:decodeshorturls
  * antispam:plugin:dkim
  * antispam:plugin:extracttext
  * antispam:plugin:freemail
  * antispam:plugin:fromenamespoof
  * antispam:plugin:olevbmacro
  * antispam:plugin:phishing
  * antispam:plugin:pyzor
  * antispam:plugin:razor2
  * antispam:plugin:relaycountry
  * antispam:plugin:sh
  * antispam:plugin:spf
  * antispam:plugin:textcat
  * antispam:plugin:txrep
  * antispam:plugin:uridnsbl
  * antispam:plugin:urilocalbl
  * antispam:plugin:vbounce
  * antispam:plugin:welcomlistsubject
  * antispam:plugins
  * antispam:rules
  * antispam:ruleupdates
  * antispam:sievelearning
  * antivirus:antivirus
  * antivirus:scanning
  * antivirus:scanninglimits
  * antivirus:signatureproviders
  * antivirus:signatureupdates
  * antivirus:signaturewhitelist
  * application:about
  * application:application
  * application:geolocation
  * application:maintenance:database
  * application:maintenance
  * application:networktools
  * application:permissions
  * application:setup
  * contentfilter:contentfilter
  * contentfilter:milter
  * contentfilter:policy
  * contentfilter:policybanks
  * contentfilter:scanner
  * help
  * mailserver:access
  * mailserver:mailserver

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

/usr/local/psa/admin/sbin/modules/warden/minion --task={task} --help

Examples

// install the warden extension
plesk bin extension --install warden

// Run the setup wizard to active the extension license, run the application installer, and configure the application
/usr/local/psa/admin/bin/modules/warden/minion --task=application:setup --license_key=XXXXXX

// set the anti-spam OK locales to western character sets only
/usr/local/psa/admin/bin/modules/warden/minion --task=antispam:antispam --ok_locales='en'

// add a custom rule to match viagra in a message subject line  and give it a +100 score
/usr/local/psa/admin/bin/modules/warden/minion --task=antispam:rules --oper=rule_add --name=NO_VIAGRA --description='messages contains viagra in the subject' --type=header --value='Subject =~ viagra' --score=100