Era.Common.DataDefinition.Task.ESS.OnDemandScan

Description

Configures on demand scan that will be executed in security product.

Properties

Name JsonSchemaType Description
cleaningEnabled boolean True if cleaning is enabled.
customProfileName string Custom profile name for custom scan profile.
powerActions reference to Era.Common.DataDefinition.Common.AllowedActions allowed actions for device users, postpone and cancel
scanProfile enum of Era.Common.DataDefinition.Task.ESS.OnDemandScan_ScanProfile Scan profile that will be used during scan.
scanTargets array of string List of scan targets. Empty list or an item equal to 'eset://alltargets' means full scan.
shutdownEnabled boolean True if shutdown is enabled after scan completition.
shutdownLocked boolean True if shutdown is enforced after scan (can not be canceled).

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.ClientTaskConfiguration

JsonSchema

{
    "title": "Era.Common.DataDefinition.Task.ESS.OnDemandScan",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Task.ESS.OnDemandScan"
    ],
    "properties": {
        "Era.Common.DataDefinition.Task.ESS.OnDemandScan": {
            "$ref": "#/definitions/OnDemandScan"
        }
    },
    "definitions": {
        "OnDemandScan": {
            "additionalProperties": false,
            "required": [
                "cleaningEnabled",
                "scanProfile"
            ],
            "type": "object",
            "properties": {
                "cleaningEnabled": {
                    "type": "boolean"
                },
                "customProfileName": {
                    "type": "string"
                },
                "powerActions": {
                    "$ref": "Era.Common.DataDefinition.Common.AllowedActions#/definitions/AllowedActions"
                },
                "scanProfile": {
                    "enum": [
                        0,
                        1,
                        2,
                        3,
                        4
                    ]
                },
                "scanTargets": {
                    "minItems": 1,
                    "type": "array",
                    "items": [
                        {
                            "type": "string"
                        }
                    ]
                },
                "shutdownEnabled": {
                    "type": "boolean"
                },
                "shutdownLocked": {
                    "type": "boolean"
                }
            }
        }
    }
}