Skip to main content
REST API reference
A newer release of this product is available.

Retrieve the Vscan On-Access policy configuration for an SVM

PDFs

GET /protocols/vscan/{svm.uuid}/on-access-policies/{name}

Retrieves the Vscan On-Access policy configuration of an SVM.

  • vserver vscan on-access-policy show

  • vserver vscan on-access-policy file-ext-to-include show

  • vserver vscan on-access-policy file-ext-to-exclude show

  • vserver vscan on-access-policy paths-to-exclude show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

name

string

path

True

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

enabled

boolean

Status of the On-Access Vscan policy

mandatory

boolean

Specifies if scanning is mandatory. File access is denied if there are no external virus-scanning servers available for virus scanning.

name

string

On-Access policy ame

scope

scope
Example response 
{
  "name": "on-access-test",
  "scope": {
    "exclude_extensions": [
      "mp*",
      "txt"
    ],
    "exclude_paths": [
      "\\dir1\\dir2\\name",
      "\\vol\\a b",
      "\\vol\\a,b\\"
    ],
    "include_extensions": [
      "mp*",
      "txt"
    ],
    "max_file_size": 2147483648
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

scope

Name Type Description

exclude_extensions

array[string]

List of file extensions for which scanning is not performed.

exclude_paths

array[string]

List of file paths for which scanning must not be performed.

include_extensions

array[string]

List of file extensions to be scanned.

max_file_size

integer

Maximum file size, in bytes, allowed for scanning.

only_execute_access

boolean

Scan only files opened with execute-access.

scan_readonly_volumes

boolean

Specifies whether or not read-only volume can be scanned.

scan_without_extension

boolean

Specifies whether or not files without any extension can be scanned.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.