Using splxmain | Trend Micro Service Central

Views:

The splxmain command enables you to maintain and control ServerProtect from the command line. You can run this command in the /opt/TrendMicro/SProtectLinux/SPLX.vsapiapp folder. Use splxmain for variousServerProtect maintenance tasks that are run through cron(8) or crond(8) or that can be run from the command line. You must have root (superuser) privileges to run splxmain.

Note

You should only use splxmain to run ServerProtect without Apache.

splxmain controls the processes ServerProtect uses for scanning, logging, updating, and so on.

Location

/opt/TrendMicro/SProtectLinux/SPLX.vsapiapp/splxmain

Syntax

splxmain [-a |-b |-c |-e |-f |-g <date> |-i |-j |-k |-l <port> |-m
                     <directory> |-n |-o |-q <Activation Code> |-r |-s |-t |-u |-v |-w <port> |-W |-x
                     |-y][-D |-E]

Note

Except for -D, specify only one parameter at a time.

Parameters

-a Terminate all vsapiapp processes, Manual Scan processes, and Scheduled Scan processes gracefully. To terminate these processes immediately, use the -k option.

-b Remove all scheduled jobs from the /etc/cron.d/splx file. file, letting currently running jobs complete.

-c Refresh the Scheduled Scan, Scheduled Update, and Scheduled Log purging settings based on the settings in the tmsplx.xml file to /etc/cron.d/splx file.

-e Read the tmsplx.xml(5) configuration file and set up the /etc/cron.d/splx tables to run Scheduled Scans, Scheduled Updates, and Automatic Log Purges, then launch vsapiapp. If the -D option is also specified, vsapiapp is run as a daemon; otherwise, it is run as a regular process. -D can be used with this option.

Note

If -D is used in conjunction with -e, vsappiapp runs as a daemon; otherwise, it runs as a regular process.

-f Reset the Web console password to the default value of null. If you forget the Web console password, you can use this option to reset it to null and then use the -j option to assign a new password.

-g <date> Purge ServerProtect log files. The <date> is an actual cut-off date specified in YYYY-MM-DD format. For example:

./splxmain –g 2006-04-21 # deletes logs written before April 21, 2006

Note

If you do not specify <date>, ServerProtect will use the value of the MaxLogDay key in the tmsplx.xml file. See MaxLogDay in Logs Group Key Set.

-i Restart the vsapiapp processes.

-j Set the Web console password. Type the new password twice for confirmation.

-k Terminate the vsapiapp processes, manual scan processes, and scheduled scan processes immediately by sending a SIGKILL signal. To terminate these processes gracefully, use the -a option.

-l <port> Set the ServerProtect HTTP port for accessing the ServerProtect Web console.

For example, ./splxmain -l xxxxx

-m <directory> Execute a Manual Scan based on the Manual Scan settings in the tmsplx.xml file. Use a colon (:) to separate multiple directories. For example, to scan /temp1 and /temp2:

./splxmain -m /temp1:/temp2

Note

Executing a manual scan does not require running or triggering the KHM.

-n Terminate the manual scan process that is currently running.

-o Remove the scheduled scan processes from the /etc/cron.d/splx file.

-p Trigger the Scheduled Update process.

-q <Activation Code> sets the Activation Code (also known as the serial number).

-r Reload the ServerProtect configuration without restarting vsapiapp.

-s Execute Scheduled Scan now. Usually, the -m option is used to run an on-demand scan. However, this option is used in /etc/cron.d/splx and can be used to run an on-demand scan with the settings specified for a Scheduled Scan specified in the tmsplx.xml file.

Note

Executing a scheduled scan does not require running or triggering the KHM.

-t Terminate the Scheduled Scan processes that are running through cron or crond. You can view the scheduled settings in the /etc/cron.d/splx file.

-u Update the scan engine and virus pattern according to tmsplx.xml and ask vsapiapp to reload these components.

-v Enable real-time scan by spawning child threads for real-time scan. Use this option only if you have disabled real-time scan with the -x option previously.

-w <port> Set the HTTPS port for accessing the ServerProtect Web console. For example:

./splxmain -w 12345

-W Set the World Virus Tracking Program (WVTP) setting. Type yes or no to enable or disable this feature.

-x Disable real-time scan by terminating the real-time scan child threads.

-y Set the user name and password for the proxy server used for component download.

-D Force vsapiapp to run as a daemon. This option can be used with -e.

-E Query the current license status.

This information is also available in the splxmain man page, which you can access from the command line by issuing this command:

man splxmain