KEY DESCRIPTION
Without keys Returns the list of all existing Kaspersky Anti-Virus tasks. The list contains the following fields: task name, task category (system, user-defined or group) and current task status.
<task alias> Instead of the task name, in the SCAN TASK command, use its Task alias, an additional short-form name that Kaspersky Anti-Virus assigns to tasks. To view Kaspersky Anti-Virus task aliases enter the command KAVSHELL TASK without any modifiers.
/START Starts the specified task in asynchronous mode
/STOP Stops the specified task
/PAUSE Pauses the specified task
/RESUME Resumes the specified task in asynchronous mode
/STATE Returns the current task status (Running, Completed, Paused, Stopped, Failed, Starting, Recovering)
/STATISTICS Retrieve task statistics - information on the number of objects processed from the time the task started until now
Return codes for the KAVSHELL TASK command (on page 161)
S TARTING AND STOPPING REAL - TIME PROTECTION TASKS . KAVSHELL RTP
Using the KAVSHELL RTP command you can start or stop all real-time protection tasks.
KAVSHELL RTP command syntax KAVSHELL RTP {/START | /STOP}
KAVSHELL RTP command examples
To start all real-time protection tasks, execute the following command:
KAVSHELL RTP /START
The KAVSHELL RTP command can include any of two mandatory modifiers (see the table below).
KAVSHELL RTP command modifiers
KEY DESCRIPTION
/START starts all real-time protection tasks.
/STOP stops all real-time protection tasks.
Return codes for KAVSHELL RTP command (on page 161)
S TARTING K ASPERSKY A NTI -V IRUS DATABASES UPDATE TASK . KAVSHELL UPDATE
The KAVSHELL UPDATE command can be used to start the Kaspersky Anti-Virus databases update command in the synchronous mode.
AD M I N I S T R A T O R'S GU I D E
152
The Kaspersky Anti-Virus databases update task, run using a KAVSHELL UPDATE command, is a temporary task. It is only displayed in the Anti-Virus console while being executed. The task execution log is generated at the same time. It is displayed in the Task logs of the Anti-Virus console. Kaspersky Security Center policies may apply to update tasks created and launched using the KAVSHELL UPDATE command and update tasks created in the Anti-Virus console. For details of Anti-Virus management on servers by means of Kaspersky Security Center, please refer to the section
"Managing Anti-Virus via Kaspersky Security Center" (see page 166).
environment variables can be used when specifying the path to updates source in this task. If a user’s environment variables are used, execute the KAVSHELL UPDATE command with the rights of this user.
Command syntax for KAVSHELL UPDATE
KAVSHELL UPDATE < Path to updates source | /AK | /KL> [/NOUSEKL]
[/PROXY:<address>:<port>] [/AUTHTYPE:<0-2>] [/PROXYUSER:<user name>]
[/PROXYPWD:<password>] [/NOPROXYFORKL] [/USEPROXYFORCUSTOM] [/NOFTPPASSIVE]
[/TIMEOUT:<seconds>] [/REG:<iso3166 code>] [/W:<path to task execution log file>]
[/ALIAS:<task alias>]
The KAVSHELL UPDATE command has both mandatory and optional keys (see the following table).
Examples of the KAVSHELL UPDATE command
To start a user-defined database update task, execute the following command:
KAVSHELL UPDATE
To run the database update task using the update files in the \\Server\databases network folder, run the following command:
KAVSHELL UPDATE \\Server\databases
To start an update task using the FTP server ftp://dnl-ru1.kaspersky-labs.com/ as the source and log all task events to the c:\update_report.log file, execute the command:
KAVSHELL UPDATE ftp://dnl-ru1.kaspersky-labs.com/ W:c:\update_report.log
To retrieve updates for Kaspersky Anti-Virus databases from an update server at Kaspersky Lab; connect to the update source via a proxy server (proxy server address: proxy.company.com, port: 8080); to access the server, use NTLM authentication integrated in Microsoft Windows logging in under an account (user name: inetuser, password: 123456), run the following command:
KAVSHELL UPDATE /KL /PROXY:proxy.company.com:8080 /AUTHTYPE:1 /PROXYUSER:inetuser /PROXYPWD:123456
MA N A G I N G KA S P E R S K Y AN T I- VI R U S F R O M T H E C O M M A N D L I N E
153
Table 31. KAVSHELL UPDATE command keys
KEY DESCRIPTION
Updates sources (mandatory key). Specify one or multiple sources. Kaspersky Anti-Virus will access the sources in the order in which they are listed. Delimit sources with a space.
<path in UNC format> User-defined updates source. Path to network update folder in the UNC format.
<URL> User-defined updates source. HTTP server address where update folder is located.
<Local folder> User-defined updates source. Folder on the protected server.
/AK Kaspersky Security Center Administration server as the updates source.
/KL Kaspersky Lab's update servers as the updates sources.
/NOUSEKL Do not use Kaspersky Lab's update servers if other updates sources are not available (used by default).
Proxy server settings
/PROXY:<address>:<port> Network name or IP address of the proxy server and its port. If this key is not specified, Kaspersky Anti-Virus will automatically detect the settings of the proxy server used in the local area network.
/AUTHTYPE:<0-2> This key specifies the authentication method to access proxy server. It can have the following values:
0 – built-in Microsoft Windows NTLM authentication; Kaspersky Anti-Virus will contact the proxy server under the Local system (SYSTEM) account;
1 – built-in Microsoft Windows NTLM authentication; Kaspersky Anti-Virus will contact the proxy server under account with login name and password specified by the keys
/PROXYUSER and /PROXYPWD;
2 – authentication by login name and password specified by keys /PROXYUSER and /PROXYPWD (basic authentication).
If authentication is not required for accessing the proxy server, there is no requirement to specify a key.
/PROXYUSER:<user
name> Username which will be used for accessing proxy server. If the value of key /AUTHTYPE:0 is specified, then /PROXYUSER:<user name> and /PROXYPWD:<password> keys will be ignored.
/PROXYPWD:<password> Username which will be used for accessing proxy server. If the value of key /AUTHTYPE:0 is specified, then /PROXYUSER:<user name> and /PROXYPWD:<password> keys will be ignored. If /PROXYUSER key is specified and /PROXYPWD omitted, the password will be considered blank.
/NOPROXYFORKL Do not use proxy server settings for connecting with Kaspersky Lab's update servers (used by default)
/USEPROXYFORCUSTOM Use proxy server settings for connecting to user-defined updates sources (not used by default).
/USEPROXYFORLOCAL Use proxy server settings for connecting to local updates sources. If not specified, the value Do not use proxy server settings to connect to the local updates sources will apply.
General FTP and HTTP server settings
/NOFTPPASSIVE If this key is specified, Kaspersky Anti-Virus will use the active FTP server mode to connect to the protected server. If this key is not specified, Kaspersky Anti-Virus will use the passive FTP server mode, if possible.
/TIMEOUT:<number of seconds>
FTP or HTTP server connection timeout. If this key is not specified, Kaspersky Anti-Virus uses the default value: 10 s. You can only use integers as the value for this key.
AD M I N I S T R A T O R'S GU I D E
154
KEY DESCRIPTION
/REG:<iso3166 code> Regional settings. This key is used when receiving updates from Kaspersky Lab's update servers. Kaspersky Anti-Virus optimizes the update load on the server by selecting the update server nearest to it.
As the value of this key, specify the letter code of the location country for the protected server in accordance with ISO 3166-1, for example /REG:gr or /REG:RU. If this key is omitted or a non-existent country code is specified, Kaspersky Anti-Virus will detect the location of the protected server based on the regional settings on the computer where Anti-Virus console is installed (for Microsoft Windows 2003 Server and above – according to the value of Location variable).
/ALIAS:<task alias> This key will allow you to assign a temporary name to the task, to be used to access the task during its execution. For example, task statistics can be viewed using the TASK command. The task alias must be unique among the task aliases of all functional components of Kaspersky Anti-Virus.
If this key is not specified, update_<kavshell_pid>, for example, update_1234 will be used.
In the Kaspersky Anti-Virus Console the task will be automatically assigned Update-databases (<date time>), for example, Update-Update-databases 8/16/2007 5:41:02 PM.
/W:<path to task execution log file>
If this key is specified, Kaspersky Anti-Virus will save the task log file with the name defined by the key's value.
The log file contains task execution statistics, the time when it was started and completed (stopped), and information about events in this task.
The log is used to register events defined by the settings of task logs and the Kaspersky Anti-Virus event log in the "Event Viewer".
Either the absolute or relative path to the log file can be specified. If only the file name is specified without its path, then the log file will be created in the current folder.
Restarting the command with the same log settings will overwrite the existing log file.
The log file can be viewed while a task is running.
The log appears in the Task logs node of Kaspersky Anti-Virus Console.
If Kaspersky Anti-Virus fails to create a log file, this will not stop the command from executing, but an error message will be displayed.
Return codes for the command KAVSHELL UPDATE (see section "Return codes for the command KAVSHELL RTP" on page 161)