Module netapp_ontap.resources.vscan_server_status

Copyright © 2019 NetApp Inc. All rights reserved.

Overview

This API is used to display connection status information for the external virus-scanning servers or "Vscan servers".

Examples

Retrieving all fields for the Vscan server status


# The API:
/api/protocols/vscan/server_status/
# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/vscan/server_status?fields=*" -H "accept: application/hal+json"
# The response:
{
  "records": [
    {
      "svm": {
        "uuid": "86fbc414-f140-11e8-8e22-0050568e0945",
        "name": "vs1",
        "_links": {
          "self": {
            "href": "/api/svm/svms/86fbc414-f140-11e8-8e22-0050568e0945"
          }
        }
      },
      "node": {
        "uuid": "fe696362-f138-11e8-8e22-0050568e0945",
        "name": "Cluster-01",
        "_links": {
          "self": {
            "href": "/api/cluster/nodes/fe696362-f138-11e8-8e22-0050568e0945"
          }
        }
      },
      "ip": "10.141.46.173",
      "type": "primary",
      "state": "disconnected",
      "disconnected_reason": "unknown",
      "_links": {
        "self": {
          "href": "/api/protocols/vscan/server_status/86fbc414-f140-11e8-8e22-0050568e0945/Cluster-01/10.141.46.173"
        }
      }
    },
    {
      "svm": {
        "uuid": "86fbc414-f140-11e8-8e22-0050568e0945",
        "name": "vs1",
        "_links": {
          "self": {
            "href": "/api/svm/svms/86fbc414-f140-11e8-8e22-0050568e0945"
          }
        }
      },
      "node": {
        "uuid": "fe696362-f138-11e8-8e22-0050568e0945",
        "name": "Cluster-01",
        "_links": {
          "self": {
            "href": "/api/cluster/nodes/fe696362-f138-11e8-8e22-0050568e0945"
          }
        }
      },
      "ip": "fd20:8b1e:b255:5053::46:173",
      "type": "primary",
      "state": "disconnected",
      "disconnected_reason": "remote_closed",
      "_links": {
        "self": {
          "href": "/api/protocols/vscan/server_status/86fbc414-f140-11e8-8e22-0050568e0945/Cluster-01/fd20%3A8b1e%3Ab255%3A5053%3A%3A46%3A173"
        }
      }
    }
  ],
  "num_records": 2,
  "_links": {
    "self": {
      "href": "/api/protocols/vscan/server_status?fields=*"
    }
  }
}

Retrieving the server status information for the server with IP address 10.141.46.173


# The API:
/api/protocols/vscan/server_status
# The call:
curl -X GET "https://<mgmt-ip>/api/protocols/vscan/server_status?ip=10.141.46.173&fields=*" -H "accept: application/hal+json"
# The response:
{
  "records": [
    {
      "svm": {
        "uuid": "86fbc414-f140-11e8-8e22-0050568e0945",
        "name": "vs1",
        "_links": {
          "self": {
            "href": "/api/svm/svms/86fbc414-f140-11e8-8e22-0050568e0945"
          }
        }
      },
      "node": {
        "uuid": "fe696362-f138-11e8-8e22-0050568e0945",
        "name": "Cluster-01",
        "_links": {
          "self": {
            "href": "/api/cluster/nodes/fe696362-f138-11e8-8e22-0050568e0945"
          }
        }
      },
      "ip": "10.141.46.173",
      "type": "primary",
      "state": "connected",
      "update_time": "2018-12-19T08:03:40.988Z",
      "vendor": "XYZ",
      "version": "1.12.2",
      "_links": {
        "self": {
          "href": "/api/protocols/vscan/server_status/86fbc414-f140-11e8-8e22-0050568e0945/Cluster-01/10.141.46.173"
        }
  ],
  "num_records": 1,
  "_links": {
    "self": {
      "href": "/api/protocols/vscan/server_status?ip=10.141.46.173&fields=*"
    }
  }
}

Classes

class VscanServerStatus (*args, **kwargs)

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

Initialize the instance of the resource.

Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

MyResource(name='foo').name == 'foo'

Args

*args
Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

Ancestors

Static methods

def find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves a Vscan server status.

  • vserver vscan connection-status show-all

Learn more


Find an instance of an object on the host given a query.

The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found or if more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A Resource object containing the details of the object.

Raises

NetAppRestError: If the API call did not return exactly 1 matching resource.

def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable

Retrieves a Vscan server status.

  • vserver vscan connection-status show-all

Learn more


Fetch a list of all objects of this type from the host.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records
The maximum number of records to return per call
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library.

Inherited members

class VscanServerStatusSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

The fields of the VscanServerStatus object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.schema.BaseSchema
  • marshmallow.base.SchemaABC

Class variables

var disconnected_reason

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
var ip

IP address of the Vscan server.

var node

The node field of the vscan_server_status.

var opts
var state

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
var svm

The svm field of the vscan_server_status.

var type

Server type. The possible values are:

  • primary - Primary server
  • backup - Backup server

Valid choices:

  • primary
  • backup
var update_time

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

var vendor

Name of the connected virus-scanner vendor.

var version

Version of the connected virus-scanner.