Automation calls
Swagger does not list the supported Client tasks. Automation calls support the following Client tasks:
Client task |
task.action.name |
---|---|
StartNetworkIsolation |
|
EndNetworkIsolation |
|
OnDemandScan |
|
ShutdownComputer |
|
StopManaging |
|
ThirdPartyAVRemove |
|
SystemUpdate |
|
RunCommand |
|
KillProcessByPid |
You can define task type using the task.action.name attribute.
Use the following examples with your own Universally Unique Identifiers (UUIDs) and task settings. Device domain calls provide the UUID of groups and devices. |
Isolate computer from network
End computer isolation from network
OnDemandScan and ShutdownComputer tasks
For OnDemandScan and ShutdownComputer, configure additional task settings with task.action.params:
{ "@type": "type.googleapis.com/Era.Common.DataDefinition.Task.OS.ShutdownComputer", "restart": false, "actions": { "cancelAction": false, "postpone": "OneHour" } } |
Parameter |
Value |
---|---|
restart |
If restart is set to true, the computer will restart; if it is set to false, the computer will shut down. |
actions |
The actions parameter specifies which actions device users are allowed to take, such as postponing or canceling. |
cancelAction |
If true user will be able to cancel the action. |
postpone |
Option to postpone action; possible postpone values are: Cannot (Default value) OneHour ThreeHours FiveHours OneDay ThreeDays SevenDays FifteenDays TwentyDays ThirtyDays |
OnDemandScan parameters:
{ "@type": "type.googleapis.com/Era.Common.DataDefinition.Task.ESS.OnDemandScan", "scanProfile": "InDepth", "customProfileName": "", "scanTargets": [ "" ], "cleaningEnabled": false, "shutdownEnabled": false, "shutdownLocked": false, "powerActions": { "cancelAction": false "postpone": "OneHour", } } |
Parameter |
Value |
---|---|
cleaningEnabled |
If true - cleaning is enabled. |
customProfileName |
Custom profile name for custom scan profile. |
scanProfile |
The scan profile that will be used during the scan. Available values: InDepth InDepth Smart ContextMenu MyProfile Custom |
scanTargets |
A list of scan targets. Empty list or an item equals eset://AllTargets which means the full scan. |
shutdownEnabled |
shutdown is enforced after scan (cannot be canceled). |
shutdownLocked |
If true shutdown is enforced after scan (cannot be canceled). |
powerActions |
The powerActions parameter specifies which actions device users can do. |
cancelAction |
If true user will be able to cancel the action. |
postpone |
Option to postpone action; possible postpone values are: Cannot (Default value) OneHour ThreeHours FiveHours OneDay ThreeDays SevenDays FifteenDays TwentyDays ThirtyDays |
Example result of OnDemandScan in task_runs[:]:
"result": { "scannedTargets": "", "scanned": 0, "infected": 0, "cleaned": 0, "severity": "LOG_INFORMATION", "@type": "type.googleapis.com/Era.Common.DataDefinition.Task.OnDemandScanResult" } |
Parameter |
Value |
---|---|
scannedTargets |
A list of scanned targets separated by semicolon. |
scanned |
A number of scanned files. |
infected |
A number of infected files. |
cleaned |
A number of cleaned files. |
severity |
A severity of scan task. |
Stop managing (Uninstall ESET Management Agent)
Software Uninstall (Third-party antivirus software)
SystemUpdate task
SystemUpdate parameters:
{ "@type": "type.googleapis.com/Era.Common.DataDefinition.Task.OS.SystemUpdate", "acceptEula": false, "installOptionalUpdates": false, "allowReboot": false, "rebootActions": { "cancelAction": false, "postpone": "OneHour" } } |
Parameter |
Value |
---|---|
acceptEula |
If set to true, the EULA is accepted automatically if any request for updates is made (only for the Windows platform). |
installOptionalUpdates |
If set to true, optional updates should be installed (only on the Windows platform). |
allowReboot |
If set to true, a restart is allowed if an update requests it. |
rebootActions |
This parameter specifies which reboot actions device users can do. |
cancelAction |
If true user will be able to cancel the reboot. |
postpone |
Option to postpone action; possible postpone values are: Cannot (Default value) OneHour ThreeHours FiveHours OneDay ThreeDays SevenDays FifteenDays TwentyDays ThirtyDays |
RunCommand task
RunCommand parameters:
{ "@type": "type.googleapis.com/Era.Common.DataDefinition.Task.OS.RunCommand", "commandLine": "", "currentDirectory": "" } |
Parameter |
Value |
---|---|
commandLine |
A platform dependent command line that will be put into script file and executed. |
currentDirectory |
The working directory for script file. |
KillProcess task
KillProcessByPid parameters:
{ "@type": "type.googleapis.com/eset.dotnod.os_integration.v1.KillProcessByPidRequest", "pid": 0, "executableHashSha1": "", "executableHashSha2_256": "" } |
Parameter |
Value |
---|---|
pid |
Integer value of the local Process ID as seen by the operating system. |
executableHashSha1 |
SHA1 hash of process executable. At least one executable_hash_sha1 or executable_hash_sha2_256 must be set; otherwise, 400 BAD REQUEST will be thrown. |
executableHashSha2_256 |
SHA2-256 hash of process executable. At least one executable_hash_sha1 or executable_hash_sha2_256 must be set; otherwise, 400 BAD REQUEST will be thrown. |