Skip to main content
REST API reference

Delete a Vscan configuration

Deletes a Vscan configuration to remove all associated settings from an SVM, including disabling Vscan and deleting scanner pools and policies. This is typically done when you no longer need virus scanning capabilities on the SVM.

HTTP method and endpoint

DELETE /protocols/vscan/{svm.uuid}

Introduced in

ONTAP 9.6

Usage notes

Important notes:

  • The Vscan DELETE endpoint deletes all of the Vscan configuration of an SVM. It first disables the Vscan and then deletes all of the SVM scanner-pools, On-Access policies, and On-Demand policies.

  • Disable the active Vscan On-Access policy on an SVM before performing the Vscan delete operation on that SVM.

  • vserver vscan scanner-pool delete

  • vserver vscan on-access-policy delete

  • vserver vscan on-demand-policy delete

Parameters

Name Type In Required Description

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

10027259

A scanner-pool, an On-Access policy, or an On-Demand policy might fail to get deleted due to either a systematic error or some hardware failure. The error code returned details the failure along with the reason for the failure. For example, "Failed to delete On-Access policy "sp1". Reason: "Failed to delete policy. Reason: policy must be disabled before being deleted.". Retry the operation."

Name Type Description

error

returned_error

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

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.