Device Servers
This context is a container for all Device Server Accounts of a particular user.
Unique Actions
[?]
New Device Server
This 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.
Action Type: | |
Action Name: | add |
Action Icon: |  |
View Device ServerS Summary
This action shows the basic properties of all Device Server Accounts registered in this container in a single read-only table.
Action Type: | Configure (read-only mode) |
Action Name: | list |
View Device ServerS Status
This actions shows the status of all Device Server Accounts registered in this container in a single read-only table.
Action Type: | Configure (read-only mode) |
Action Name: | status |
Action Icon: |  |
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 
icon.
Advanced Information |
Context Information
Context Type: deviceServers
Context Name: deviceservers
Context Description: Device Servers
Context Path: users.USER_NAME.deviceservers
Context Mask: users.*.deviceservers
Context Permissions: Observer
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 Observer 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 Observer permission level | ||
Input Records: | 0 | ||
Input Format: | None | ||
Output Records: | 0...unlimited | ||
Output Format: | Description | Type | Name |
|---|---|---|---|
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 Observer permission level | ||
Input Records: | 0 | ||
Input Format: | None | ||
Output Records: | 0...unlimited | ||
Output Format: | Description | Type | Name |
|---|---|---|---|
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 Observer permission level | ||
Input Records: | 1 | ||
Input Format: | Description | Type | Name |
|---|---|---|---|
name | String |
| |
password | String |
| |
description | String |
| |
registerindns | Boolean |
| |
blocked | Boolean |
| |
Output Records: | 0 | ||
Output Format: | None | ||
Public Events
[?]
Common Events: info (Information)
Was this page helpful?