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

Retrieve the Vscan scanner-pool configuration for an SVM

PDFs

GET /protocols/vscan/{svm.uuid}/scanner-pools/{name}

Introduced In: 9.6

Retrieves the configuration of a specified scanner-pool of an SVM.

  • vserver vscan scanner-pool show

  • vserver vscan scanner-pool privileged-users show

  • vserver vscan scanner-pool servers show

Learn more

Parameters

Name Type In Required Description

name

string

path

True

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

cluster

cluster_reference

name

string

Specifies the name of the scanner pool. Scanner pool name can be up to 256 characters long and is a string that can only contain any combination of ASCII-range alphanumeric characters a-z, A-Z, 0-9), "_", "-" and ".".

privileged_users

array[string]

Specifies a list of privileged users. A valid form of privileged user-name is "domain-name\user-name". Privileged user-names are stored and treated as case-insensitive strings. Virus scanners must use one of the registered privileged users for connecting to clustered Data ONTAP for exchanging virus-scanning protocol messages and to access file for scanning, remedying and quarantining operations.

  • example: ["cifs\u1", "cifs\u2"]

  • Introduced in: 9.6

role

string

Specifies the role of the scanner pool. The possible values are:

  • primary - Always active.

  • secondary - Active only when none of the primary external virus-scanning servers are connected.

  • idle - Always inactive.

servers

array[string]

Specifies a list of IP addresses or FQDN for each Vscan server host names which are allowed to connect to clustered ONTAP.

  • example: ["1.1.1.1", "10.72.204.27", "vmwin204-27.fsct.nb"]

  • Introduced in: 9.6

svm

svm
Example response 
{
  "cluster": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cluster1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "scanner-1",
  "privileged_users": [
    "cifs\\u1",
    "cifs\\u2"
  ],
  "role": "string",
  "servers": [
    "1.1.1.1",
    "10.72.204.27",
    "vmwin204-27.fsct.nb"
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

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

href

Name Type Description

href

string

_links

Name Type Description

self

href

cluster_reference

Name Type Description

_links

_links

name

string

uuid

string

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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.