Device Servers

Top  Previous  Next

This context is a container for all Device Server Accounts of a particular user.

Unique Actions [?]

cm_create NEW Device Server

This Call Function action is used to create a new Device Server account. It prompts the user to enter some basic properties for the new account:

Name
Password
Description
Register Device Server in DNS
Blocked

See descriptions of these properties here.

VIEW Device ServerS SUMMARY (Default Action)

This action shows the basic properties of all Device Server Accounts registered in this container in a single read-only table.

cm_status View Device ServerS Status

This actions shows the status of all Device Server Accounts registered in this container in a single read-only table.

Common Actions [?]

Replicate To Children, Edit Context Permissions, Monitor Related Events, various Grouped Actions according to child contexts.

Context States and Icons

This context has no states. It is always represented by the st_deviceservers icon.

Advanced Information

Context Information

Context type: DeviceServersContext

Context name: deviceservers

Context description: Device Servers

Context path: users.USER_NAME.deviceservers

Context mask: users.*.deviceservers

Context permissions: User

Public Variables (Properties) [?]

Device Servers Status

Returns status of all Device Servers under the current account. More information about Device Server status may be found here.

Variable Name:

status

Records:

0...unlimited

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 [?]

List Device Servers

This function returns information about all Device Server Accounts available under current user account. Account properties are described here.

 

Function Name:

list

Permissions:

Accessible at User permission level

Input Records:

0

Input format:

None

Output Records:

0...unlimited

Output format:

Name

Type

Description

owner

String

 

name

String


password

String


description

String


registerindns

Boolean


blocked

Boolean


inbandpassthrough

Boolean


timezone

String


deviceplugin

String


List All Device Servers

This function returns information about all Device Server Accounts in the system that are accessible with current permission level. Account properties are described here.

 

Function Name:

listAll

Permissions:

Accessible at User permission level

Input Records:

0

Input format:

None

Output Records:

0...unlimited

Output format:

Name

Type

Description

owner

String

 

name

String


password

String


description

String


registerindns

Boolean


blocked

Boolean


inbandpassthrough

Boolean


timezone

String


deviceplugin

String


Register New Device Server

Creates new Device Server Account. Account properties are described here.

 

Function Name:

add

Permissions:

Accessible at User permission level

Input Records:

1

Input format:

Name

Type

Description

name

String


password

String


description

String


registerindns

Boolean


blocked

Boolean


Output Records:

0

Output format:

None

Public Events [?]

Common Events: info (Information)