Device Server

Top Previous Next

This context is used to access and manage a single Device Server.

Unique Actions [?]

EDIT Device Server PROPERTIES (Default Action)

This Configure action is used to edit properties of Device Server Account.

CONFIGURE Device Server

This action is used to edit settings of hardware Device Server. Its differences from a standard Configure action is that Device Server is rebooted when new settings are saved.

CONFIGURE DATA TRANSFER/DEVICE PLUGIN

This Configure action is used to edit Device Server-level properties of a Data Transfer/Device Plugin associated with Device Server Account. Plugin type is defined in the basic properties of the Device Server Account. See the plugin description for information about available properties.

View Device ServerS Status

This action shows status of Device Server Account.

BUZZ

This Call Function action buzzes a hardware Device Server.

REBOOT

This Call Function action reboots a hardware Device Server.

VIEW DATA FLOW

This action is used to monitor data routed between hardware Device Server and LinkServer. See details here.

Common Actions [?]

Delete, Replicate, Edit Context Permissions, Monitor Related Events

Context States and Icons

	Device Server if offline
	Device Server is online (connected to the LinkServer)
	Device Server Account is blocked, login attempts will be denied

Some Data Transfer/Device Plugins may affect the state and icon of this context. For example, the Transparent Data Routing (Link Service) plugin sets context icon to and status to Client connected when some third-party software is connected to the LinkServer using a dedicated port specified in the plugin settings for this Device Server Account and exchanges data with current Device Server.

In other words, you see this icon when the LinkServer is used as a transparent "pipe" between a Device Server and some other software.

Advanced Information

Context Information

Context type: DeviceServerContext

Context name: provided by user

Context description: provided by user

Context path: users.USER_NAME.deviceservers.DEVICE_SERVER_ACCOUNT_NAME

Context mask: users.*.deviceservers.*

Context permissions: User

Public Variables (Properties) [?]

Device Server INFORMATION

Returns properties of a Device Server Account.

Variable Name:	deviceServerInfo
Records:	1
Permissions:	Readable at User permission level

Record Format:

Name	Type	Description
owner	String
name	String
password	String
description	String
registerindns	Boolean
blocked	Boolean
inbandpassthrough	Boolean
timezone	String
deviceplugin	String

Device Server Status

Returns status of a Device Server Account.

Variable Name:	status
Records:	1
Permissions:	Readable at User permission level

Record Format:

Field Name	Field Type	Notes
name	String
online	Boolean
pluginStatus	String
dsToServer	Long
serverToDs	Long
creationtime	Date
updatetime	Date
realip	String	Nullable
realport	Integer	Nullable
logintime	Date	Nullable
internalip	String	Nullable

Public Functions [?]

Send Commands

This function sends several commands to a hardware Device Server and returns its replies.

Function Name:

commands

Permissions:

Accessible at User permission level

Input Records:

1...unlimited

Input format:

Name	Type	Description
command	String	Command text.

Output Records:

1...unlimited

Output format:

Name	Type	Description
successful	Boolean	True is command was successfully sent and replied by Device Server.
errortext	String	Text of error message if some I/O error occurred while sending command.
reply	String	Text of reply received from a Device Server if command was successfully replied.

Send NON-REPLIED Commands

This function sends several commands to a hardware Device Server but doesn't expect to get any replies from it.

Function Name:

nonRepliedCommands

Permissions:

Accessible at User permission level

Input Records:

1...unlimited

Input format:

Name	Type	Description
command	String	Command text.

Output Records:

1...unlimited

Output format:

Name

Type

Description

successful

Boolean

True is command was successfully sent to Device Server.

Successful sending a non-replied command via UDP does not mean that is was received and processed by Device Server.

errortext

String

Text of error message if some I/O error occurred while sending command.

BUZZ

Buzzes Device Server.

Function Name:	buzz
Permissions:	Accessible at User permission level
Input Records:	0
Input format:	None
Output Records:	0
Output format:	none

REBOOT

Reboots Device Server.

Function Name:	reboot
Permissions:	Accessible at User permission level
Input Records:	0
Input format:	None
Output Records:	0
Output format:	none

DISCONNECT

Causes server to close TCP connection with a hardware Device Server. It will attempt to reconnect to the Device Server in several seconds.

Function Name:	disconnect
Permissions:	Accessible at User permission level
Input Records:	0
Input format:	None
Output Records:	0
Output format:	none

REMOVE

Permanently destroys Device Server Account.

Function Name:	remove
Permissions:	Accessible at User permission level
Input Records:	0
Input format:	None
Output Records:	0
Output format:	none

Public Events [?]

Common Events: info (Information), contextStatusChanged (Status Changed)

CONNECTION

This event is fired upon device server connection and successful login.

Event Name	connection
Permissions:	Accessible at User permission level
Records:	0

DISCONNECTION

This event is fired upon device server disconnection.

Event Name	disconnection
Permissions:	Accessible at User permission level
Records:	0