Virtual server object model

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

The object model describing this resource contains the following objects.

virtualServer

Attribute JSON Type Data Type Description
objectId string string Virtual server object unique identifier. Note: this ID is not HNAS storage virtual server ID.
virtualServerId number ushort HNAS virtual server ID.
status string string Status of the virtual server. Possible values are:
  • ONLINE
  • NOT_CONFIGURED
  • DISABLED
  • OFFLINE
UUID string string UUID of the virtual server.
ipAddresses array array IP addresses for the virtual server.
name string string Name of the virtual server.
type string string Type of the virtual server. Possible values can be:
  • File Services

  • Administrative Services

isEnabled boolean boolean True if the virtual server is enabled.

scanServer (RPC mode)

Attribute JSON Type Data Type Description
name string string Name of the virus scan engine server
inUse boolean boolean True if the virus scan server is in use
ipAddress string string IP of the virus scan server
domain string string Domain name of the virus scan service
scanStatus number integer Status of the virus scan server

scanServer (ICAP mode)

Attribute JSON Type Data Type Description
hostName string string Host name of the virus scan engine server
enabled boolean boolean True if the virus scan server is enabled
ipAddress string string IP of the virus scan server
port number integer Port of the virus scan server
serviceName string string Service name of the virus scan service
scanStatus number integer Status of the virus scan server

virusScan

Attribute JSON Type Data Type Description
fileExtensions array array A list of file extensions the virus scan run against
areAllFileTypesScanned boolean boolean Virus scan run for all file types or not
isSuccessful boolean boolean Virus scan successful or not
isVirusScanEnabled boolean boolean Virus scan enabled or not
mode string string Virus scan mode: RPC or ICAP
scanServers array array A list of objects of scanServer that describes the virus scan server configuration of either RPC mode or ICAP mode.