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

Retrieve the Vscan server status

Contributors
PDFs

GET /protocols/vscan/server-status

Introduced In: 9.6

Retrieves a Vscan server status.

  • vserver vscan connection-status show-all

Learn more

Parameters

Name Type In Required Description

version

string

query

False

Filter by version

interface.uuid

string

query

False

Filter by interface.uuid

  • Introduced in: 9.10

interface.name

string

query

False

Filter by interface.name

  • Introduced in: 9.10

interface.ip.address

string

query

False

Filter by interface.ip.address

  • Introduced in: 9.10

ip

string

query

False

Filter by ip

disconnected_reason

string

query

False

Filter by disconnected_reason

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

state

string

query

False

Filter by state

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

vendor

string

query

False

Filter by vendor

type

string

query

False

Filter by type

update_time

string

query

False

Filter by update_time

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: 1

  • 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_server_status]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "disconnected_reason": "string",
      "interface": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ip": {
          "address": "10.10.10.7"
        },
        "name": "lif1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "ip": "string",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "state": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "string",
      "update_time": "string",
      "vendor": "string",
      "version": "string"
    }
  ]
}

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

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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

vscan_server_status

Displays the connection status information of the external virus-scanning servers.

Name Type Description

disconnected_reason

string

Specifies the server disconnected reason. The following is a list of the possible reasons:

  • unknown - Disconnected, unknown reason.

  • vscan_disabled - Disconnected, Vscan is disabled on the SVM.

  • no_data_lif - Disconnected, SVM does not have data LIF.

  • session_uninitialized - Disconnected, session is not initialized.

  • remote_closed - Disconnected, server has closed the connection.

  • invalid_protocol_msg - Disconnected, invalid protocol message received.

  • invalid_session_id - Disconnected, invalid session ID received.

  • inactive_connection - Disconnected, no activity on connection.

  • invalid_user - Connection request by an invalid user.

  • server_removed - Disconnected, server has been removed from the active Scanners List. enum:

  • unknown

  • vscan_disabled

  • no_data_lif

  • session_uninitialized

  • remote_closed

  • invalid_protocol_msg

  • invalid_session_id

  • inactive_connection

  • invalid_user

  • server_removed

interface

interface

Address of the interface used for the Vscan connection.

ip

string

IP address of the Vscan server.

node

node

state

string

Specifies the server connection state indicating if it is in the connected or disconnected state. The following is a list of the possible states:

  • connected - Connected

  • disconnected - Disconnected enum:

  • connected

  • disconnected

svm

svm

type

string

Server type. The possible values are:

  • primary - Primary server

  • backup - Backup server

update_time

string

Specifies the time the server is in the connected or disconnected state.

vendor

string

Name of the connected virus-scanner vendor.

version

string

Version of the connected virus-scanner.

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.