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

Retrieve Vscan events

PDFs

GET /protocols/vscan/{svm.uuid}/events

Introduced In: 9.11

Retrieves Vscan events, which are generated by the cluster to capture important events.

  • vserver vscan show-events

Parameters

Name Type In Required Description

server

string

query

False

Filter by server

vendor

string

query

False

Filter by vendor

version

string

query

False

Filter by version

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

event_time

string

query

False

Filter by event_time

disconnect_reason

string

query

False

Filter by disconnect_reason

type

string

query

False

Filter by type

interface.uuid

string

query

False

Filter by interface.uuid

interface.ip.address

string

query

False

Filter by interface.ip.address

interface.name

string

query

False

Filter by interface.name

svm.name

string

query

False

Filter by svm.name

file_path

string

query

False

Filter by file_path

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[vscan_event]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "disconnect_reason": "string",
      "event_time": "2021-11-24 23:29:41 -0500",
      "file_path": "/1",
      "interface": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ip": {
          "address": "10.10.10.7"
        },
        "name": "lif1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "server": "192.168.1.1",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "string",
      "vendor": "mighty master anti-evil scanner",
      "version": "1.0"
    }
  ]
}

Error

Status: Default, Error
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

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

interface

Address of the interface used for the Vscan connection.

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in.

uuid

string

The UUID that uniquely identifies the interface.

node

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

vscan_event

Name Type Description

disconnect_reason

string

Specifies the reason of the Vscan server disconnection. The available values are:

  • na Not applicable

  • vscan_disabled Vscan disabled on the SVM

  • no_data_lif SVM does not have data lif on the node

  • session_uninitialized Session not initialized

  • remote_closed Closure from Server

  • invalid_protocol_msg Invalid protocol-message received

  • invalid_session_id Invalid session-id received

  • inactive_connection No activity on connection

  • invalid_user Connection request by invalid user

  • server_removed Server removed from the active scanner-pool

event_time

string

Specifies the Timestamp of the event.

file_path

string

Specifies the file for which event happened.

interface

interface

Address of the interface used for the Vscan connection.

node

node

server

string

Specifies the IP address of the Vscan server.

svm

svm

SVM, applies only to SVM-scoped objects.

type

string

Specifies the event type.

vendor

string

Specifies the scan-engine vendor.

version

string

Specifies the scan-engine version.

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.