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

Boolean runningOnly - 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. [optional]

  • Returns

List[String, String] - A list of strings representing Gateway Network server IDs.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# The following creates a list of running servers on the Gateway Network, and shows 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)
Keywords

system net getRemoteServers, net.getRemoteServers