To use the command line interface to perform actions on objects quarantined by the Kaspersky Endpoint Agent application:
cd
command to change to the directory where the agent.exe file is located.For example, you can type cd "C:\Program Files (x86)\Kaspersky Lab\Endpoint Agent\"
and press ENTER.
agent.exe --quarantine=delete --ouid=<
comma-separated IDs of quarantined objects. Mandatory option>
[--pwd=<
current user password>]
.
Objects with the specified IDs are deleted from the workstation quarantine folder that was specified during configuring Quarantine settings.
agent.exe --quarantine=restore --ouid=<
comma-separated IDs of quarantined objects. Mandatory option> [--path-type=<
one of the destination folder options for restoring quarantined objects: original
|custom
|settings
. Optional option> --path=<
path to the destination folder for restored objects. Mandatory option if the --path-type
option is specified and the specified value is original>] [--action=<
one of the actions for the object: replace|rename
. Optional option>] [--pwd=<
current user password>]
.
agent.exe --quarantine=add [--file=<
full path to the object that you want to quarantine>] [--pwd=<
current user password>]
.agent.exe --quarantine=add [--hash=<
hash of the object that you want to quarantine. Mandatory option if you are not specifying the full path to the object and pass the --hashalg
option>]--hashalg=<
one of the hash types: md5|sha256
. Mandatory option if you are not specifying the full path to the object> [--file=<
path to the folder that contains the object that you want to quarantine>] [--pwd=<
current user password>]
.Command options for performing actions on quarantined objects
Parameter |
Description |
|
Mandatory option. The option is used to pass a unique numerical (int64) ID of the quarantined object. Displayed when viewing information about quarantined objects ( |
|
The option describes the logic of selecting the destination folder when restoring and object from Quarantine.
|
|
Mandatory option if the This option specifies the path where you want to create a folder for objects restored from Quarantine if you do not want to use the folder where the object was located before it was quarantined or the folder specified during configuring Quarantine settings. |
|
This option specifies the action that you want to perform for the object if the destination folder for restored objects already contains a file with the same name as the file you are restoring from Quarantine.
|
|
Mandatory option if the This option specifies the full path to the object that you want to quarantine. |
|
Mandatory option if the This option specifies the hash algorithm that is used to compute the checksum of the object that you want to quarantine. This option can be specified with one of two values: |
|
Mandatory option if the This option specifies the checksum of the object that you want to quarantine. |
|
Mandatory option if the --hashalg option is specified. This option specifies the path to the folder which contains the object that you want to quarantine and whose hash is specified in the |
|
Lets you enter the password of the user account that is used to run the command. |
Return codes of the --quarantine
command: