system.net.getRemoteServers

This function is used in Python Scripting.

Description

This function returns a List of Gateway Network servers that are visible from the local Gateway.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.net.getRemoteServers([runningOnly])

Parameters

Type	Parameter	Description
Boolean	runningOnly	[Optional] If set to True, only servers on the Gateway Network that are running will be returned. Servers that have lost contact with the Gateway Network will be filtered out.

Returns

String[] - A List of Strings representing Gateway Network server ids.

Scope

All

Code Examples

Code Snippet

# The following will create a list of running servers on the Gateway Network, and show the list in a message box.
 
# Collect the list of running servers
runningServers = system.net.getRemoteServers(True)
  
# Initialize the start of the message
serverStatusText = "The following servers are running:\n "
# Add each running server to the message
for server in runningServers:
    serverStatusText += "%s \n" % server
  
# Show the message
system.gui.messageBox(serverStatusText)